Документация/Все методы API

Создание возврата

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

Запрос

Правила подписи
ЗаголовкиAccept: application/json · Content-Type: application/json

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

Ответ

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

application/json
{
  "id": "123456789",
  "refund_status": "new",
  "status": "success"
}
Поля выбранного запроса4
invoice_idstring · обязательное

ID платежа, присвоенный платёжной платформой.

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

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

notification_urlstring

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

signaturestring

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

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

Создаёт возврат по оплаченному платежу. Для частичного возврата передайте amount, для полного не передавайте его. Сумма возврата не должна превышать доступную для возврата сумму платежа. Ответ подтверждает создание возврата; завершение возврата сообщается отдельно.

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

Все параметры и схемы

Свернуть схему

Тело запроса

application/json
  1. body

Запрос возврата по существующему платежу.

amount?|

Сумма возврата; отсутствие суммы в запросе обрабатывается согласно настройкам мерчанта.

invoice_id*|

ID платежа, присвоенный платёжной платформой.

merchant_id*|

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

notification_url?|

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

signature?|

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

Тело ответа

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

application/json
  1. response

Результат создания возврата.

id*|

ID возврата, присвоенный платёжной платформой.

refund_status*string

Текущий статус возврата.

status*string

Результат выполнения запроса API.