Получение заблокированного баланса водителя

Request

GET

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

Query parameters

Name

Description

contractor_profile_id*

Type: string

Идентификатор профиля водителя

Example: 9b17db0cb1f24a38a5c3c8b4f6e4f63b

Headers

Name

Description

X-API-Key*

Type: string

API-ключ

Example: <API-ключ>

Min length: 1

X-Park-ID*

Type: string

Идентификатор партнера

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Responses

200 OK

Заблокированный баланс водителя

Body

application/json

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

Name

Description

blocked_balance*

Type: string

Заблокированный баланс водителя

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

details*

Type: BalanceDetails

Детали заблокированного баланса водителя

BalanceDetails

Детали заблокированного баланса водителя

Name	Description
blocked_bonuses	Type: string Заблокированные бонусы Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
blocked_cashless	Type: string Заблокированные деньги за поездки Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
blocked_closing_documents	Type: string Заблокированные деньги за закрывающие документы Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
blocked_financial_statements	Type: string Заблокированные деньги за финансовые отчеты Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
blocked_tips	Type: string Заблокированные чаевые Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Была ли статья полезна?

Получение времени водителя на линии

Получение списка условий работы