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

Example: <API key>

Min length: 1

X-Park-ID*

Type: string

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Responses

200 OK

Driver's blocked balance

Body

application/json

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

Name	Description
balance*	Type: string Driver's balance Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
blocked_balance*	Type: string Driver's blocked balance Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
details*	Type: BalanceDetails Driver's blocked balance details

BalanceDetails

Driver's blocked balance details

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

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
    "code": "string",
    "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

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
    "code": "string",
    "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

404 Not Found

Requested resource was not found

Body

application/json

{
    "code": "string",
    "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

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
    "code": "string",
    "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

500 Internal Server Error

Internal server error

Body

application/json

{
    "code": "string",
    "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

Was the article helpful?

Getting driver's online time

Getting list of work rules