Создание запроса на выплату

POST/withdrawal

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

Как использовать запрос

1. Укажите реквизиты получателя

Выберите пример /withdrawal для подключённого способа выплаты. Передайте новый order, сумму, валюту и обязательные поля получателя.

2. Выполните следующий шаг

Обработайте withdrawal_request.redirect, если он получен. Для продолжения используйте полученные url, method и form_data.

3. Подтвердите двухстадийную выплату

В двухстадийном режиме подтвердите созданную выплату через /withdrawal/submit или отмените её через /withdrawal/cancel до обработки.

4. Подтвердите итоговый статус

Проверьте /withdrawal_request по id или order либо обработайте webhook выплаты с проверкой подписи. Проверяйте поля ответа вместе с HTTP-статусом.

POSThttps://secure-api.404stage.com/withdrawalПрямой запрос к API

Запрос

Правила подписи

Заголовки

Дополнительные заголовки · по одному на строкуAccept: application/json · Content-Type: application/json

Укажите свои реквизиты и подпись. Запрос отправляется на адрес выше.

Ответ

Запрос выполнен; проверяйте статус операции в ответе.

Общий пример ответа

application/json

{
  "status": "success",
  "withdrawal_request": {
    "account_id": "27",
    "amount": "0.0000",
    "created_at": "2023-12-28T11:01:24.167742+03:00",
    "id": "853",
    "merchant_id": "1",
    "parts": [],
    "redirect": {},
    "requested_amount": "100.1200",
    "status": "new",
    "to_masked_pan": "411111XXXXXX1111"
  }
}

Поля выбранного запроса17

amountstring

Сумма выплаты; передайте amount или requested_amount.

currencystring · обязательное

Код валюты выплаты.

customerstring

Уникальный идентификатор плательщика в системе мерчанта.

endpoint_idstring

ID платёжного эндпоинта; передайте endpoint_id или product_id.

merchant_idstring · обязательное

ID мерчанта, выданный при подключении.

notification_urlstring

URL мерчанта для уведомлений о статусе выплаты.

orderstring · обязательное

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

payment_methodstring

Способ выплаты, настроенный для эндпоинта.

phone_numberstring

Телефон получателя для выплаты по номеру телефона.

receiver_account_numberstring

Номер банковского счёта получателя.

receiver_bank_namestring

Название банка получателя.

receiver_branch_codestring

Код отделения банка получателя.

receiver_countrystring

Страна получателя.

receiver_emailstring

Email получателя.

receiver_first_namestring

Имя получателя.

receiver_last_namestring

Фамилия получателя.

signaturestring · обязательное

Подпись запроса; рассчитывается по правилам раздела о подписи запросов.

Описание и правила метода

Создаёт выплату по токену карты, PAN, номеру телефона (payment_method=spb для СБП) или банковским реквизитам. Доступные способы зависят от вашего endpoint.

Примеры выплат на карту, SEPA и FPS

Для этих сценариев передайте amount, currency, новый order, merchant_id, подключённый endpoint_id, customer, notification_url и signature, а также реквизиты из таблицы. Выберите соответствующий именованный пример запроса.

Способ	Валюта	`payment_method`	Реквизиты для этого сценария
Карта (Host2Host)	Валюта, доступная endpoint	Не передаётся	`pan`, `receiver_first_name`, `receiver_last_name`
SEPA	`EUR`	`sepa`	`receiver_iban`, `receiver_first_name`, `receiver_last_name`, `receiver_country`, `receiver_city`, `receiver_address`, `receiver_postalcode`
Faster Payments (Великобритания)	`GBP`	`fps`	`receiver_account_number`, `receiver_sort_code`, `receiver_first_name`, `receiver_last_name`

В этих сценариях передавайте имена и адресные данные получателя латиницей. Для SEPA используйте код страны ISO 3166-1 alpha-2. Для FPS передавайте номер счёта и шестизначный sort code строками, сохраняя начальные нули. Это требования конкретных способов выплаты: поле, необязательное в общей схеме API, может требоваться подключённым способом.

status: "success" подтверждает создание выплаты, а не отправку средств. Проверяйте withdrawal_request.status через /withdrawal_request или webhook с проверенной подписью: done означает завершение, rejected - отклонение. Для выплат без карты, в том числе SEPA и FPS, to_masked_pan в ответе и masked_pan в webhook пустые.

В двухстадийном режиме сначала создайте выплату, затем вызовите /withdrawal/submit для обработки или /withdrawal/cancel для возврата зарезервированных средств.

В notification_url укажите адрес вашего webhook для уведомлений о выплате. Если ответ содержит withdrawal_request.redirect.url, перенаправьте клиента с указанными method и form_data.

Передавайте JSON в теле запроса (Content-Type: application/json). Рассчитывайте signature по общим правилам подписи для пути URL этого метода. Подписи в примерах — заполнители: замените реквизиты доступа и URL, укажите новый order для новой выплаты и пересчитайте подпись по окончательному телу запроса.

Все параметры и схемыРасширенный справочник метода