Перейти к содержанию

Получение черновика по ID

Метод получения информации о черновике выплаты по ID.

URL

Метод: GET

  • Production: https://api.pay.kvell.group/v1/payout-drafts/{payout_draft_id}
  • Stage: https://api.pay.stage.kvell.group/v1/payout-drafts/{payout_draft_id}

Параметры пути

Название
Тип данных Обязательно Описание
payout_draft_id integer Да ID черновика выплаты

Пример запроса

GET /v1/payout-drafts/42

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Signature string Да Подпись

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, payout_draft_id и secret_key. Формируется sha256 от полученной строки:

sha256({X-Api-Key}{payout_draft_id}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта;

Ответ запроса

Возвращает объект черновика выплаты. Если черновик подтверждён, дополнительно содержит поле order_details с данными созданной транзакции.

Пример ответа

{
  "id": 42,
  "draft_guid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "payout_type": "card",
  "point_id": 1,
  "amount": 100000,
  "status": "created",
  "number": "draft-001",
  "recipient_full_name": "Иванов Иван Иванович",
  "recipient_card_mask": "411111******1111",
  "description": "Выплата по договору №123",
  "comment": "Выплата за март",
  "created_at": "2024-03-01T10:00:00",
  "updated_at": "2024-03-01T10:00:00",
  "documents": [],
  "orders": [],
  "order_details": null
}
{
  "id": 42,
  "draft_guid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "payout_type": "card",
  "point_id": 1,
  "amount": 100000,
  "status": "confirmed",
  "number": "draft-001",
  "recipient_full_name": "Иванов Иван Иванович",
  "recipient_card_mask": "411111******1111",
  "description": "Выплата по договору №123",
  "comment": "Выплата за март",
  "created_at": "2024-03-01T10:00:00",
  "updated_at": "2024-03-01T10:05:00",
  "documents": [],
  "orders": [
    {
      "id": 1,
      "order_id": "order-abc-123",
      "transaction": "draft-001",
      "amount": 100000,
      "commission": 0,
      "created_at": "2024-03-01T10:05:00",
      "updated_at": "2024-03-01T10:05:00"
    }
  ],
  "order_details": {
    "id": "order-abc-123",
    "status": "completed",
    "transaction": "draft-001",
    "amount": 100000,
    "commission": 0,
    "inner_commission": 0,
    "description": "Выплата по договору №123",
    "redirect_url": null,
    "extra_data": {},
    "error_code": null,
    "error_message": null,
    "created_at": "2024-03-01T10:05:00"
  }
}
{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Параметры ответа

Название Тип данных Описание
id integer ID черновика
draft_guid string GUID черновика
payout_type string Тип выплаты
point_id integer ID торговой точки
amount integer Сумма в копейках
status string Статус черновика
number string Номер черновика
customer_key string Ключ покупателя
recipient_full_name string ФИО получателя
recipient_card_token string Токен карты получателя
recipient_card_mask string Маска карты получателя
recipient_phone string Телефон получателя
recipient_bank_id string ID банка получателя
description string Описание
comment string Комментарий
created_at datetime Дата и время создания
updated_at datetime Дата и время последнего обновления
documents array Список документов
orders array Список созданных заказов
order_details object Данные транзакции. Заполняется только для подтверждённых черновиков

Объект orders[]

Название Тип данных Описание
id integer ID записи
order_id string ID заказа в платёжной системе
transaction string Номер транзакции
amount integer Сумма в копейках
commission integer Комиссия в копейках
created_at datetime Дата и время создания
updated_at datetime Дата и время последнего обновления

Объект order_details (Представляет собой совершенную выплату. Подробнее Статус транзакции)

Название Тип данных Описание
id string ID заказа в платёжной системе
status string Статус транзакции
transaction string Номер транзакции
amount integer Сумма в копейках
commission integer Комиссия в копейках
inner_commission integer Внутренняя комиссия в копейках
description string Описание
redirect_url string Ссылка для перенаправления
extra_data object Дополнительные данные
error_code string Код ошибки (при наличии)
error_message string Сообщение об ошибке (при наличии)
created_at string Дата и время создания

Список статусов черновика

Название Описание
created Черновик создан
awaiting_confirmation Ожидает подтверждения
confirmed Черновик подтверждён
canceled Черновик отменён

Список статусов выплаты

Название Описание
new Новая транзакция
processing Операция обрабатывается
canceled Операция отклонена
completed Операция выполнена
refunded Операция возвращена
part_refunded Операция частично возвращена
reversed Операция отменена
part_reversed Операция частично отменена