Getting driver's balance and blocked balance

Request

GET

https://fleet-api.taxi.yandex.net/v1/parks/contractors/blocked-balance

Query parameters

Name

Description

contractor_id

Type: string

Driver's profile ID

Example: 9b17db0cb1f24a38a5c3c8b4f6e4f63b

Headers

Name

Description

X-API-Key

Type: string

API-key

Min length: 1

Example: <API key>

X-Park-ID

Type: string

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Responses

200 OK

Driver's blocked balance

Body

application/json

{
  "balance": "example",
  "blocked_balance": null,
  "details": {
    "blocked_tips": null,
    "blocked_cashless": null,
    "blocked_bonuses": null,
    "blocked_financial_statements": null,
    "blocked_closing_documents": null
  }
}

Name	Description
balance	Type: Decimal4 Driver's balance Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_balance	Type: Decimal4 Driver's blocked balance Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
details	Type: BalanceDetails Driver's blocked balance details Example `{ "blocked_tips": "example", "blocked_cashless": null, "blocked_bonuses": null, "blocked_financial_statements": null, "blocked_closing_documents": null }`

Decimal4

Type: string

Pattern: ^-?[0-9]+(\.[0-9]{1,4})?$

Example: example

BalanceDetails

Driver's blocked balance details

Name	Description
blocked_bonuses	Type: Decimal4 Blocked bonuses Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_cashless	Type: Decimal4 Blocked money for trips Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_closing_documents	Type: Decimal4 Blocked money for closing documents Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_financial_statements	Type: Decimal4 Blocked money for financial statements Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`
blocked_tips	Type: Decimal4 Blocked tips Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$` Example: `example`

Example

{
  "blocked_tips": "example",
  "blocked_cashless": null,
  "blocked_bonuses": null,
  "blocked_financial_statements": null,
  "blocked_closing_documents": null
}

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
  "code": "example",
  "message": "Textual description of the error"
}

Name

Description

message

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Example: example

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
  "code": "example",
  "message": "Textual description of the error"
}

Name

Description

message

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Example: example

404 Not Found

Requested resource was not found

Body

application/json

{
  "code": "example",
  "message": "Textual description of the error"
}

Name

Description

message

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Example: example

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
  "code": "example",
  "message": "Textual description of the error"
}

Name

Description

message

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Example: example

500 Internal Server Error

Internal server error

Body

application/json

{
  "code": "example",
  "message": "Textual description of the error"
}

Name

Description

message

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Example: example

Was the article helpful?

Getting driver's online time

Getting a list of contractor applications from the garage