Создание черновика

Метод создания черновика выплаты. Черновик можно использовать для подготовки выплаты перед её фактическим исполнением.

URL

Метод: POST

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

Параметры запроса

Название	Тип данных	Обязательно	Описание
payout_type	string	Да	Тип выплаты: card, sbp, account
amount	integer	Да	Сумма в копейках
description	string	Да	Описание выплаты
number	string	Нет	Номер черновика (произвольный идентификатор)
customer_key	string	Нет	Ключ покупателя
recipient_bank_id	string	Нет	ID банка получателя
recipient_full_name	string	Нет	ФИО получателя
recipient_card_pan	string	Нет	Номер карты получателя
recipient_card_token	string	Нет	Токен карты получателя
recipient_phone	string	Нет	Телефон получателя
comment	string	Нет	Комментарий к черновику
documents	array	Нет	Список документов (см. ниже)

Объект documents[]

Название	Тип данных	Описание
document_number	string	Номер документа
document_date	date	Дата документа (формат YYYY-MM-DD)

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

{
  "payout_type": "card",
  "amount": 100000,
  "description": "Выплата по договору №123",
  "number": "draft-001",
  "recipient_full_name": "Иванов Иван Иванович",
  "recipient_card_pan": "4111111111111111",
  "comment": "Выплата за март",
  "documents": [
    {
      "document_number": "АКТ-2024-001",
      "document_date": "2024-03-01"
    }
  ]
}

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

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

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

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

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

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

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

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

200: OK422: Validation error

{
  "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": []
}

{
  "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	Список созданных заказов

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

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