Получение статуса транзакции на балансе исполнителя

Request

GET

https://fleet-api.taxi.yandex.net/v3/parks/driver-profiles/transactions/status

Query parameters

Name	Description
contractor_profile_id*	Type: string Идентификатор профиля водителя Example: `9b17db0cb1f24a38a5c3c8b4f6e4f63b`
id*	Type: string Идентификатор транзакции
park_id*	Type: string Идентификатор партнера Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
version*	Type: integer Версия транзакции Min value: `1`

Responses

200 OK

Информация о статусе транзакции

Body

application/json

{
    "id": "string",
    "park_id": "string",
    "contractor_profile_id": "string",
    "version_info": {
        "version": 0,
        "created_at": "2019-08-08T11:58:01+00:00",
        "status": "in_progress",
        "status_description": "string",
        "amount": "1050.5000"
    },
    "latest_version": 0,
    "latest_success_version": 0
}

Name	Description
contractor_profile_id*	Type: string Идентификатор исполнителя Min length: `1` Max length: `100`
id*	Type: string Min length: `1` Max length: `1000`
latest_version*	Type: integer Min value: `1`
park_id*	Type: string Идентификатор парка Min length: `1` Max length: `100`
latest_success_version	Type: integer Min value: `1`
version_info	Type: EventVersion Версия транзакции

EventVersion

Версия транзакции

Name	Description
amount*	Type: string Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
created_at*	Type: string<date-time> Дата и время в формате ISO 8601 с временной зоной Example: `2019-08-08T11:58:01+00:00`
status*	Type: EventStatus Статус обработки события Enum: `in_progress`, `success`, `fail`
version*	Type: integer Min value: `1`
status_description	Type: string Min length: `1` Max length: `1000`

EventStatus

Статус обработки события

Type	Description
EventStatus	Enum: `in_progress`, `success`, `fail`

400 Bad Request

Некорректные параметры запроса

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

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

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

Создание транзакции на балансе водителя (курьера)