Объект выплаты

Объект выплаты (Payout) содержит всю информацию о выплате, актуальную на текущий момент времени. Он формируется при создании выплаты и приходит в ответ на любой запрос, связанный с выплатами.

ПАРАМЕТР

ОПИСАНИЕ

idstring, required

Идентификатор выплаты.

shop_idnumber, required

Идентификатор магазина.

statusstring, required

Статус выплаты. Возможные значения:

• NEW — выплата создана, но пока ещё не обрабатывается
• PROCESS — выплата в процессе обработки
• DONE — выплата успешно завершена, указанная в запросе сумма переведена на указанные реквизиты (финальный и неизменяемый статус);
• CANCELED — выплата отменена (финальный и неизменяемый статус).

descriptionstring, optional

Описание транзакции (не более 128 символов). Например: «Выплата по заказу №123».

amountobject, required

Сумма выплаты.

final_amountobject, required

Сумма выплаты, которая была списана с баланса магазина – значение amount включая комиссию.

payout_destinationobject, required

Реквизиты, на которые будет произведена выплата.

created_atstring, required

Дата и время создания выплаты в формате ISO 8601.

metadataobject, optional

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от API. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Пример объекта

{
  "id": "0ea32d04-8640-424d-a227-ee5b2330f55c",
  "shop_id": 33661,
  "status": "DONE",
  "description": "Выплата по заказу №123",
  "amount": {
    "value": 1000,
    "currency": "RUB"
  },
  "final_amount": {
    "value": 1015,
    "currency": "RUB"
  },
  "payout_destination": {
    "type": "bank_card",
    "card": {
      "firsrt6": "411111",
      "last4": "1111"
    }
  },
  "created_at": "2025-02-27T15:55:05.600Z",
  "metadata": {}
}