Создание транзакции на балансе водителя (курьера)
Создание транзакции на балансе водителя (курьера)
HTTP-запрос
POST https://fleet-api.taxi.yandex.net/v2/parks/driver-profiles/transactions
Заголовки запроса
X-Client-ID * | string Идентификатор клиента |
X-API-Key * | string API-ключ |
X-Idempotency-Token * | string Токен идемпотентности запроса, |
* Обязательный параметр
Тело запроса
{ "amount": "12345.1434", "category_id": "partner_service_manual_3", "description": "Списание №13", "driver_profile_id": "33de650c6a1a40bfa78dd981817da866", "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4" }
Скопировано
Представление
Поля
amount * | string Сумма с фиксированной точностью |
category_id * | string Категория создаваемой транзакции, |
description * | string |
driver_profile_id * | string Идентификатор водителя |
park_id * | string Идентификатор партнёра |
* Обязательный параметр
Ответы
Код 200
Транзакция создана успешно
{ "amount": "12345.1434", "category_id": "partner_service_recurring_payment", "created_by": { "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a", "dispatcher_name": "Вася Пупкин", "identity": "dispatcher", "passport_uid": "123456789" }, "currency_code": "RUB", "description": "Списание №13", "driver_profile_id": "33de650c6a1a40bfa78dd981817da866", "event_at": "2019-08-08T11:58:01+03:00", "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4" }
Скопировано
Представление
Поля
amount * | string Сумма с фиксированной точностью |
category_id * | string Категория транзакции. Примеры значений:
Cписок является динамическим. Полный список категорий доступен через API /v2/parks/transactions/categories/list. |
created_by * | object |
created_by. | string Идентификатор диспетчера |
created_by. | string Имя диспетчера |
created_by. | string Возможные значения
|
created_by. | string Паспортный идентификатор пользователя |
created_by. | string Возможные значения
|
created_by. | string fleet-api client id |
created_by. | string Возможные значения
|
created_by. | string fleet-api api key id |
created_by. | string Возможные значения
|
currency_code * | string |
description * | string |
driver_profile_id * | string Идентификатор водителя |
event_at * | string ISO 8601 с временной зоной |
park_id * | string Идентификатор партнёра |
amount * | string Сумма с фиксированной точностью |
category_id * | string Категория транзакции. Примеры значений:
Cписок является динамическим. Полный список категорий доступен через API /v2/parks/transactions/categories/list. |
created_by * | object |
created_by. | string Идентификатор диспетчера |
created_by. | string Имя диспетчера |
created_by. | string Возможные значения
|
created_by. | string Паспортный идентификатор пользователя |
created_by. | string Возможные значения
|
created_by. | string fleet-api client id |
created_by. | string Возможные значения
|
created_by. | string fleet-api api key id |
created_by. | string Возможные значения
|
currency_code * | string |
description * | string |
driver_profile_id * | string Идентификатор водителя |
event_at * | string ISO 8601 с временной зоной |
park_id * | string Идентификатор партнёра |
* Обязательный параметр
Код 400
Некорректные параметры запроса
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 401
Отсутствуют параметры авторизации запроса
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 403
Недостаточно прав для выполнения запроса
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 429
Превышено допустимое число запросов
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Код 500
Внутренняя ошибка сервера
{ "code": "string", "message": "Текстовое описание ошибки" }
Скопировано
Представление
Поля
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
code | string Машиночитаемый код ошибки |
message * | string Человекочитаемое сообщение об ошибке |
* Обязательный параметр
Пример
Request:
curl -X POST "https://fleet-api.taxi.yandex.net/v2/parks/driver-profiles/transactions" \ -H "X-Client-ID: <Идентификатор клиента>" \ -H "X-API-Key: <API-ключ>" \ -H "X-Idempotency-Token: c56fa6537e5a4adbbce6ef3593210fb9" \ -d '{ "amount": "12345.1434", "category_id": "partner_service_manual_3", "description": "Списание №13", "driver_profile_id": "33de650c6a1a40bfa78dd981817da866", "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4" }'
Скопировано
Responses:
{ "amount": "12345.1434", "category_id": "partner_service_recurring_payment", "created_by": { "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a", "dispatcher_name": "Вася Пупкин", "identity": "dispatcher", "passport_uid": "123456789" }, "currency_code": "RUB", "description": "Списание №13", "driver_profile_id": "33de650c6a1a40bfa78dd981817da866", "event_at": "2019-08-08T11:58:01+03:00", "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано
{ "message": "Текстовое описание ошибки" }
Скопировано