Создание транзакции на балансе исполнителя

Request

POST

https://fleet-api.taxi.yandex.net/v3/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": "string",
    "contractor_profile_id": "string",
    "amount": "1050.5000",
    "description": "string",
    "condition": {
        "balance_min": "1050.5000"
    },
    "version": 0,
    "data": {
        "kind": "other",
        "reason": "string"
    }
}

Name	Description
amount*	Type: string Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
contractor_profile_id*	Type: string Идентификатор исполнителя Min length: `1` Max length: `100`
data*	Type: OtherData or RentData or DepositData or PayoutData or InsuranceData or FineData or DamageData or FuelData or ReferalData or TopupData or BonusData
park_id*	Type: string Идентификатор парка Min length: `1` Max length: `100`
condition	Type: Condition Условия выполнения транзакции
description	Type: string Min length: `1` Max length: `256`
version	Type: integer Версия транзакции, должна быть больше существующей версии транзакции или 1 для новой. Можно изменить только сумму. Min value: `1`

OtherData

Данные, если нет категории для этого типа транзакции

Name

Description

kind*

Type: string

Enum: other

reason*

Type: string

Короткое описание, за что было произведено списание/начисление

Min length: 1

Max length: 1000

RentData

Данные транзакции связанные с арендой

Name	Description
kind*	Type: string Enum: `rent`
object*	Type: ObjectInfo Объект транзакции
schedule	Type: ScheduleType Расписание совершения транзакции

DepositData

Данные транзакции связанные с депозитом средств

Name	Description
kind*	Type: string Enum: `deposit`
object*	Type: ObjectInfo Объект транзакции
limits	Type: Limits Лимиты транзакции
schedule	Type: ScheduleType Расписание совершения транзакции

PayoutData

Данные транзакции связанные с выплатой средств

Name	Description
fee_amount*	Type: string Значение комиссии, удержанных с исполнителя. Влияет на баланс исполнителя. Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
kind*	Type: string Enum: `payout`
bank_fee	Type: string Значение комиссии, удержанной банком Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
masked_requisites	Type: PayoutMaskedRequisites Маскированные реквизиты, по которым совершена транзакция
rule	Type: TransactionRule Правила начисления комиссии при выполнении транзакции

InsuranceData

Данные транзакции связанные с оплатой страховки

Name	Description
kind*	Type: string Enum: `insurance`
object*	Type: ObjectInfo Объект транзакции
limits	Type: Limits Лимиты транзакции
schedule	Type: ScheduleType Расписание совершения транзакции

FineData

Данные транзакции связанные с оплатой штрафов

Name	Description
kind*	Type: string Enum: `fine`
object*	Type: ObjectInfo Объект транзакции
park_fee*	Type: string Значение комиссии, удержанных с исполнителя. Влияет на баланс исполнителя. Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
integrator_fee	Type: string Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
uin	Type: string Уникальный идентификатор начисления Min length: `1` Max length: `1000`

DamageData

Данные транзакции связанные с оплатой расходов при повреждении транспортного средства

Name	Description
kind*	Type: string Enum: `damage`
limits*	Type: Limits Лимиты транзакции
object*	Type: ObjectInfo Объект транзакции
schedule*	Type: ScheduleType Расписание совершения транзакции

FuelData

Данные транзакции связанные с оплатой топлива

Name	Description
kind*	Type: string Enum: `fuel`
object*	Type: ObjectInfo Объект транзакции
category	Type: string Категория топлива: 92/98/пропан/бутан Min length: `1` Max length: `100`
type	Type: string Тип топлива Min length: `1` Max length: `100`
units	Type: Units Единица измерения объема Enum: `liters`, `cubic_meters`
value	Type: string Значение объема Min length: `1` Max length: `10`

ReferalData

Данные транзакции связанные с реферальной программой

Name	Description
kind*	Type: string Enum: `referal`
chiled_driver_id	Type: string Идентификатор объекта Min length: `1` Max length: `100`
parent_driver_id	Type: string Идентификатор объекта Min length: `1` Max length: `100`
required_orders_count	Type: integer Количество заказов, которое исполнитель должен совершить для получения бонуса Min value: `0`

TopupData

Данные транзакции связанные с пополнением счета исполнителя

Name	Description
fee_amount*	Type: string Значение комиссии, удержанных с исполнителя. Влияет на баланс исполнителя. Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
kind*	Type: string Enum: `topup`
bank_fee	Type: string Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
rule	Type: TransactionRule Правила начисления комиссии при выполнении транзакции

BonusData

Данные транзакции связанные с выплатой бонусов исполнителю

Name	Description
kind*	Type: string Enum: `bonus`
orders_count	Type: integer Количество заказов необходимых для получения бонуса. 0, если бонус при найме. Min value: `0`
receipt_condition	Type: string Короткое описание, за что был получен бонус Min length: `1` Max length: `1000`

Condition

Условия выполнения транзакции

Name

Description

balance_min*

Type: string

Минимальный баланс до выполнения транзакции

Example: 1050.5000

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

ObjectInfo

Объект транзакции

Name	Description
object_id*	Type: string Идентификатор объекта Min length: `1` Max length: `100`
object_type*	Type: ObjectType Тип объекта транзакции Enum: `vehicle`, `other`
object_name	Type: string Тип объекта, если нет подходящего типа объекта Min length: `1` Max length: `1000`

ScheduleType

Расписание совершения транзакции

Name

Description

holidays*

Type: integer

Количество выходных дней

working_days*

Type: integer

Количество рабочих дней

Limits

Лимиты транзакции

Name

Description

limit*

Type: string

До какой суммы накапливается депозит

Example: 1050.5000

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

remains*

Type: string

Сколько осталось выплатить депозита

Example: 1050.5000

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

PayoutMaskedRequisites

Маскированные реквизиты, по которым совершена транзакция

Name

Description

date

Type: string

Дата привязки карты (если перевод по карте)

Min length: 1

Max length: 1000

value

Type: string

Маскированное значение реквизита (номер карты, номер телефона...)

Pattern: ^\*{1,30}.{1,5}$

TransactionRule

Правила начисления комиссии при выполнении транзакции

Name

Description

fee_min_amount

Type: string

Значение минимальной комиссии

Example: 1050.5000

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

fee_percent

Type: string

Example: 1.5

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

Units

Единица измерения объема

Type	Description
Units	Enum: `liters`, `cubic_meters`

ObjectType

Тип объекта транзакции

Type	Description
ObjectType	Enum: `vehicle`, `other`

Responses

200 OK

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

Body

application/json

{
    "id": "string",
    "created_at": "2019-08-08T11:58:01+00:00",
    "status": "in_progress",
    "version": 0,
    "status_description": "string"
}

Name	Description
created_at*	Type: string<date-time> Дата и время в формате ISO 8601 с временной зоной Example: `2019-08-08T11:58:01+00:00`
id*	Type: string
status*	Type: EventStatus Статус обработки события Enum: `in_progress`, `success`, `fail`
version*	Type: integer
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

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

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

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

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