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

Request

POST

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

Headers

Name	Description
X-API-Key*	Type: string API-ключ Example: `<API-ключ>` Min length: `1`
X-Client-ID*	Type: string Идентификатор клиента Example: `<Идентификатор клиента>` Min length: `1`
X-Idempotency-Token*	Type: string Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов Example: `c56fa6537e5a4adbbce6ef3593210fb9` Min length: `16` Max length: `64`

Body

application/json

{
    "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
    "category_id": "partner_service_manual_3",
    "amount": "12345.1434",
    "description": "Списание №13"
}

Name	Description
amount*	Type: string Сумма с фиксированной точностью Example: `12345.1434` Max length: `20`
category_id*	Type: string Категория создаваемой транзакции. Разрешены категории с `is_creatable` равным `true` в списке категорий транзакций Example: `partner_service_manual_3`
description*	Type: string Example: `Списание №13`
driver_profile_id*	Type: string Идентификатор водителя Example: `33de650c6a1a40bfa78dd981817da866` Min length: `1` Max length: `100`
park_id*	Type: string Идентификатор партнёра Example: `ee6f33c4562b4e1f8646d157bd70b2c4` Min length: `1` Max length: `100`

Responses

200 OK

Транзакция создана успешно

Body

application/json

{
    "event_at": "2019-08-08T08:58:01.000Z",
    "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
    "category_id": "partner_service_manual",
    "amount": "12345.1434",
    "currency_code": "RUB",
    "description": "Списание №13",
    "created_by": {
        "identity": "dispatcher",
        "passport_uid": "123456789",
        "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
        "dispatcher_name": "Вася Пупкин"
    }
}

Name	Description
amount*	Type: string Сумма с фиксированной точностью Example: `12345.1434` Max length: `20`
category_id*	Type: string Категория транзакции. Допустимые значения можно получить через API /v2/parks/transactions/categories/list. Example: `partner_service_manual` Min length: `1` Max length: `100`
created_by*	Type: TransactionCreatedByDispatcher or TransactionCreatedByTechSupport or TransactionCreatedByFleetAPI or TransactionCreatedByPlatform
currency_code*	Type: string Example: `RUB`
description*	Type: string Example: `Списание №13`
driver_profile_id*	Type: string Идентификатор водителя Example: `33de650c6a1a40bfa78dd981817da866` Min length: `1` Max length: `100`
event_at*	Type: string<date-time> ISO 8601 с временной зоной Example: `Thu Aug 08 2019 11:58:01 GMT+0300 (Moscow Standard Time)`
park_id*	Type: string Идентификатор партнёра Example: `ee6f33c4562b4e1f8646d157bd70b2c4` Min length: `1` Max length: `100`

TransactionCreatedByDispatcher

Name	Description
dispatcher_id*	Type: string Идентификатор диспетчера Example: `3621b3429ea04d989adf5ff4d5515d6a`
dispatcher_name*	Type: string Имя диспетчера Example: `Вася Пупкин`
identity*	Type: string Example: `dispatcher` Enum: `dispatcher`
passport_uid*	Type: string Паспортный идентификатор пользователя Example: `123456789`

TransactionCreatedByTechSupport

Name

Description

identity*

Type: string

Example: tech-support

Enum: tech-support

TransactionCreatedByFleetAPI

Name	Description
client_id*	Type: string fleet-api client id Example: `taxi/park/abc123`
identity*	Type: string Example: `fleet-api` Enum: `fleet-api`
key_id*	Type: string fleet-api api key id Example: `521`

TransactionCreatedByPlatform

Name

Description

identity*

Type: string

Example: platform

Enum: platform

400 Bad Request

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

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

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

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

Получение трека по заказу

Получение списка транзакций по водителю (курьеру)