Подтверждение черновика

Метод подтверждения черновика выплаты. Создаёт на основе черновика фактический заказ на выплату.

URL

Метод: POST

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

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

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

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

POST /v1/payout-drafts/42/confirm

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

Название	Тип данных	Обязательно	Описание
`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 - секретный ключ, который находится в настройках магазина мерчанта;

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

Возвращает обновлённый объект черновика выплаты.

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

200: OK422: Validation error5XX: Ошибка

{
  "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",
  "created_at": "2024-03-01T10:00:00",
  "updated_at": "2024-03-01T10:05:00",
  "documents": [],
  "orders": [
    {
      "id": 1,
      "order_id": "order-abc-123",
      "transaction": "txn-xyz-789",
      "amount": 100000,
      "commission": 0,
      "created_at": "2024-03-01T10:05:00",
      "updated_at": "2024-03-01T10:05:00"
    }
  ]
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Если получен ответ со статусом 5XX, значит выплата не была создана. Надежным вариантом будет проверить отсутствие сформированной выплаты в личном кабинете. После чего повторить подтверждение черновика.
Данные ошибки могут возникнуть по различным причинам: на стороне взаимодействия сети, технических сбоев сервера или ПО.
В случае повторного возникновения данной проблемы рекомендуется обратиться в службу поддержки.

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

Название	Тип данных	Описание
`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	Список созданных заказов

Объект `orders[]`

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

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

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