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

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

Request

POST

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

Headers

Name

Description

X-API-Key

Type: string

API-ключ

Min length: 1

Example: <API-ключ>

X-Client-ID

Type: string

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

Min length: 1

Example: <Идентификатор клиента>

X-Idempotency-Token

Type: string

Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов

Min length: 16

Max length: 64

Example: c56fa6537e5a4adbbce6ef3593210fb9

Body

application/json
{
  "park_id": "example",
  "contractor_profile_id": "example",
  "amount": "1050.5000",
  "description": "example",
  "condition": {
    "balance_min": null
  },
  "version": 1,
  "data": {
    "kind": "other",
    "reason": "example"
  }
}

Name

Description

amount

Type: Amount

Сумма транзакции. Если знак '-' то сумма будет списана с баланса, если '+' добавлена на баланс. Должна быть отличная от 0.

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

Example: 1050.5000

contractor_profile_id

Type: ContractorProfileId

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

Min length: 1

Max length: 100

Example: example

data
One of 11 types

  • Type: OtherData

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

    Example
    {
  "kind": "other",
  "reason": "example"
}

  • Type: RentData

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

    Example
    {
  "kind": "rent",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  }
}

  • Type: DepositData

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

    Example
    {
  "kind": "deposit",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  },
  "limits": {
    "limit": "1050.5000",
    "remains": null
  }
}

  • Type: PayoutData

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

    Example
    {
  "kind": "payout",
  "fee_amount": "1050.5000",
  "bank_fee": null,
  "rule": {
    "fee_percent": "1.5",
    "fee_min_amount": null
  },
  "masked_requisites": {
    "value": "example",
    "date": "example"
  }
}

  • Type: InsuranceData

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

    Example
    {
  "kind": "insurance",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  },
  "limits": {
    "limit": "1050.5000",
    "remains": null
  }
}

  • Type: FineData

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

    Example
    {
  "kind": "fine",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "park_fee": "1050.5000",
  "integrator_fee": null,
  "uin": null
}

  • Type: DamageData

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

    Example
    {
  "kind": "damage",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  },
  "limits": {
    "limit": "1050.5000",
    "remains": null
  }
}

  • Type: FuelData

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

    Example
    {
  "kind": "fuel",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "type": "example",
  "category": "example",
  "value": "example",
  "units": "liters"
}

  • Type: ReferalData

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

    Example
    {
  "kind": "referal",
  "parent_driver_id": "example",
  "child_driver_id": null,
  "required_orders_count": 0
}

  • Type: TopupData

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

    Example
    {
  "kind": "topup",
  "fee_amount": "1050.5000",
  "bank_fee": null,
  "rule": {
    "fee_percent": "1.5",
    "fee_min_amount": null
  }
}

  • Type: BonusData

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

    Example
    {
  "kind": "bonus",
  "orders_count": 0,
  "receipt_condition": "example"
}
Example
{
  "kind": "other",
  "reason": "example"
}

park_id

Type: ParkId

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

Min length: 1

Max length: 100

Example: example

condition

Type: Condition

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

Example
{
  "balance_min": "1050.5000"
}

description

Type: string

Min length: 1

Max length: 256

Example: example

version

Type: integer

Версия транзакции, должна быть больше существующей версии транзакции или 1 для новой. Можно изменить только поля влияющие на сумму транзакции: 'amount', 'fee_amount', 'park_fee'. Условия (поле 'condition') не применяются при обновлении транзакции.

Min value: 1

ParkId

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

Type: string

Min length: 1

Max length: 100

Example: example

ContractorProfileId

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

Type: string

Min length: 1

Max length: 100

Example: example

Amount

Type: string

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

Example: 1050.5000

Condition

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

Name

Description

balance_min

Type: Amount

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

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

Example: 1050.5000
Example
{
  "balance_min": "1050.5000"
}

SafeString

Type: string

Min length: 1

Max length: 1000

Example: example

OtherData

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

Name

Description

kind

Type: string

Const: other

Example: example

reason

Type: SafeString

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

Min length: 1

Max length: 1000

Example: example
Example
{
  "kind": "other",
  "reason": "example"
}

ExternalObjectId

Идентификатор объекта

Type: string

Min length: 1

Max length: 100

Example: example

ObjectType

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

Type: string

Enum: vehicle, other

ObjectInfo

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

Name

Description

object_id

Type: ExternalObjectId

Идентификатор объекта

Min length: 1

Max length: 100

Example: example

object_type

Type: ObjectType

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

Enum: vehicle, other

object_name

Type: SafeString

Тип объекта, если нет подходящего типа объекта

Min length: 1

Max length: 1000

Example: example
Example
{
  "object_id": "example",
  "object_type": "vehicle",
  "object_name": "example"
}

ScheduleType

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

Name

Description

holidays

Type: integer

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

working_days

Type: integer

Количество рабочих дней
Example
{
  "working_days": 0,
  "holidays": 0
}

RentData

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

Name

Description

kind

Type: string

Const: rent

Example: example

object

Type: ObjectInfo

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

Example
{
  "object_id": "example",
  "object_type": "vehicle",
  "object_name": "example"
}

schedule

Type: ScheduleType

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

Example
{
  "working_days": 0,
  "holidays": 0
}
Example
{
  "kind": "rent",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  }
}

Limits

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

Name

Description

limit

Type: Amount

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

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

Example: 1050.5000

remains

Type: Amount

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

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

Example: 1050.5000
Example
{
  "limit": "1050.5000",
  "remains": null
}

DepositData

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

Name

Description

kind

Type: string

Const: deposit

Example: example

object

Type: ObjectInfo

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

Example
{
  "object_id": "example",
  "object_type": "vehicle",
  "object_name": "example"
}

limits

Type: Limits

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

Example
{
  "limit": "1050.5000",
  "remains": null
}

schedule

Type: ScheduleType

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

Example
{
  "working_days": 0,
  "holidays": 0
}
Example
{
  "kind": "deposit",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  },
  "limits": {
    "limit": "1050.5000",
    "remains": null
  }
}

FeePercent

Type: string

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

Example: 1.5

TransactionRule

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

Name

Description

fee_min_amount

Type: Amount

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

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

Example: 1050.5000

fee_percent

Type: FeePercent

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

Example: 1.5
Example
{
  "fee_percent": "1.5",
  "fee_min_amount": "1050.5000"
}

PayoutMaskedRequisites

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

Name

Description

date

Type: SafeString

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

Min length: 1

Max length: 1000

Example: example

value

Type: string

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

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

Example: example
Example
{
  "value": "example",
  "date": "example"
}

PayoutData

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

Name

Description

fee_amount

Type: Amount

Значение комиссии, удержанных с исполнителя. Влияет на баланс исполнителя. Если знак '-' то сумма будет списана с баланса, если '+' добавлена на баланс.

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

Example: 1050.5000

kind

Type: string

Const: payout

Example: example

bank_fee

Type: Amount

Значение комиссии, удержанной банком

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

Example: 1050.5000

masked_requisites

Type: PayoutMaskedRequisites

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

Example
{
  "value": "example",
  "date": "example"
}

rule

Type: TransactionRule

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

Example
{
  "fee_percent": "1.5",
  "fee_min_amount": "1050.5000"
}
Example
{
  "kind": "payout",
  "fee_amount": "1050.5000",
  "bank_fee": null,
  "rule": {
    "fee_percent": "1.5",
    "fee_min_amount": null
  },
  "masked_requisites": {
    "value": "example",
    "date": "example"
  }
}

InsuranceData

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

Name

Description

kind

Type: string

Const: insurance

Example: example

object

Type: ObjectInfo

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

Example
{
  "object_id": "example",
  "object_type": "vehicle",
  "object_name": "example"
}

limits

Type: Limits

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

Example
{
  "limit": "1050.5000",
  "remains": null
}

schedule

Type: ScheduleType

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

Example
{
  "working_days": 0,
  "holidays": 0
}
Example
{
  "kind": "insurance",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  },
  "limits": {
    "limit": "1050.5000",
    "remains": null
  }
}

FineData

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

Name

Description

kind

Type: string

Const: fine

Example: example

object

Type: ObjectInfo

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

Example
{
  "object_id": "example",
  "object_type": "vehicle",
  "object_name": "example"
}

park_fee

Type: Amount

Значение комиссии, удержанных с исполнителя. Влияет на баланс исполнителя. Если знак '-' то сумма будет списана с баланса, если '+' добавлена на баланс.

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

Example: 1050.5000

integrator_fee

Type: Amount

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

Example: 1050.5000

uin

Type: SafeString

Уникальный идентификатор начисления

Min length: 1

Max length: 1000

Example: example
Example
{
  "kind": "fine",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "park_fee": "1050.5000",
  "integrator_fee": null,
  "uin": null
}

DamageData

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

Name

Description

kind

Type: string

Const: damage

Example: example

limits

Type: Limits

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

Example
{
  "limit": "1050.5000",
  "remains": null
}

object

Type: ObjectInfo

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

Example
{
  "object_id": "example",
  "object_type": "vehicle",
  "object_name": "example"
}

schedule

Type: ScheduleType

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

Example
{
  "working_days": 0,
  "holidays": 0
}
Example
{
  "kind": "damage",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "schedule": {
    "working_days": 0,
    "holidays": 0
  },
  "limits": {
    "limit": "1050.5000",
    "remains": null
  }
}

FuelType

Тип топлива

Type: string

Min length: 1

Max length: 100

Example: example

FuelCategory

Категория топлива: 92/98/пропан/бутан

Type: string

Min length: 1

Max length: 100

Example: example

Value

Значение объема

Type: string

Min length: 1

Max length: 10

Example: example

Units

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

Type: string

Enum: liters, cubic_meters

FuelData

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

Name

Description

kind

Type: string

Const: fuel

Example: example

object

Type: ObjectInfo

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

Example
{
  "object_id": "example",
  "object_type": "vehicle",
  "object_name": "example"
}

category

Type: FuelCategory

Категория топлива: 92/98/пропан/бутан

Min length: 1

Max length: 100

Example: example

type

Type: FuelType

Тип топлива

Min length: 1

Max length: 100

Example: example

units

Type: Units

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

Enum: liters, cubic_meters

value

Type: Value

Значение объема

Min length: 1

Max length: 10

Example: example
Example
{
  "kind": "fuel",
  "object": {
    "object_id": "example",
    "object_type": "vehicle",
    "object_name": "example"
  },
  "type": "example",
  "category": "example",
  "value": "example",
  "units": "liters"
}

ReferalData

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

Name

Description

kind

Type: string

Const: referal

Example: example

child_driver_id

Type: ExternalObjectId

Идентификатор объекта

Min length: 1

Max length: 100

Example: example

parent_driver_id

Type: ExternalObjectId

Идентификатор объекта

Min length: 1

Max length: 100

Example: example

required_orders_count

Type: integer

Количество заказов, которое исполнитель должен совершить для получения бонуса

Min value: 0
Example
{
  "kind": "referal",
  "parent_driver_id": "example",
  "child_driver_id": null,
  "required_orders_count": 0
}

TopupData

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

Name

Description

fee_amount

Type: Amount

Значение комиссии, удержанных с исполнителя. Влияет на баланс исполнителя. Если знак '-' то сумма будет списана с баланса, если '+' добавлена на баланс.

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

Example: 1050.5000

kind

Type: string

Const: topup

Example: example

bank_fee

Type: Amount

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

Example: 1050.5000

rule

Type: TransactionRule

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

Example
{
  "fee_percent": "1.5",
  "fee_min_amount": "1050.5000"
}
Example
{
  "kind": "topup",
  "fee_amount": "1050.5000",
  "bank_fee": null,
  "rule": {
    "fee_percent": "1.5",
    "fee_min_amount": null
  }
}

BonusData

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

Name

Description

kind

Type: string

Const: bonus

Example: example

orders_count

Type: integer

Количество заказов необходимых для получения бонуса. 0, если бонус при найме.

Min value: 0

receipt_condition

Type: SafeString

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

Min length: 1

Max length: 1000

Example: example
Example
{
  "kind": "bonus",
  "orders_count": 0,
  "receipt_condition": "example"
}

Responses

200 OK

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

Body

application/json
{
  "id": "example",
  "created_at": "2019-08-08T11:58:01+00:00",
  "status": "in_progress",
  "version": 0,
  "status_description": "example",
  "event_id": "example"
}

Name

Description

created_at

Type: DateTime

Дата и время в формате ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+00:00

event_id

Type: string

Идентификатор события, инициирующий создание транзакций через api

Example: example

id

Type: string

Example: example

status

Type: EventStatus

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

Enum: in_progress, success, fail

version

Type: integer

status_description

Type: SafeString

Min length: 1

Max length: 1000

Example: example

DateTime

Дата и время в формате ISO 8601 с временной зоной

Type: string<date-time>

Example: 2019-08-08T11:58:01+00:00

EventStatus

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

Type: string

Enum: in_progress, success, fail

400 Bad Request

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

403 Forbidden

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

429 Too Many Requests

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

500 Internal Server Error

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

No longer supported, please use an alternative and newer version.

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