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

Возврат средств

Операция полностью или частично возвращает деньги на карту клиента в случае полной или частичной отмены заказа или возврата товара. Для запроса на возврат средств нужен UID транзакции Оплаты или Списания средств. Возврат возможен в случае, если стоимость ниже или такая же, как и стоимость транзакции в той же валюте. Возврат средств также позволяет выполнять несколько частичных возвратов.


Запрос

Отправьте POST запрос на https://demo-gateway.begateway.com/transactions/refunds со следующими параметрами:

Параметр Тип Описание
parent_uid * обязательный
string UID транзакции оплаты или списания средств.
amount * обязательный
integer Сумма возврата в минимальных денежных единицах, например 1000 для $10.00.
reason * обязательный
string (255) Причина возврата.
duplicate_check boolean Параметр управляет процессом проверки входящего запроса на уникальность. Если в течение 30 секунд придет запрос на возврат средств с одинаковыми amount и parent_uid, то запрос будет отклонен. По умолчанию, этот параметр имеет значение true.
Пример запроса
{
  "request":{
    "parent_uid":"1-310b0da80b",
    "amount":50,
    "reason":"Client request"
  }
}
Ответ
Параметр Тип Описание
transaction object
uid * обязательный
string UID обработанной транзакции.
status * обязательный
string Статус обработанной транзакции.
message * обязательный
string Сообщение с результатом запроса.
type * обязательный
string Тип транзакции.
receipt_url * обязательный
string Ссылка на квитанцию обработанной транзакции.
code * обязательный
string Код обработки транзакции.
friendly_message * обязательный
string Сообщение для покупателя с описанием кода ошибки из параметра code.
Пример ответа
{
  "transaction": {
    "uid": "1cbf77cb-ed58-40f2-8bb4-0be10f12fda8",
    "status": "successful",
    "amount": 492,
    "currency": "EUR",
    "reason": "Client request",
    "type": "refund",
    "message": "Successfully processed",
    "test": true,
    "created_at": "2024-04-02T14:01:09.302Z",
    "updated_at": "2024-04-02T14:01:12.460Z",
    "paid_at": "2024-04-02T14:01:12.397Z",
    "closed_at": null,
    "settled_at": null,
    "manually_corrected_at": null,
    "parent_uid": "5e14b86f-1bb9-40ad-b42a-b925176aec63",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/1cbf77cb-ed58-40f2-8bb4-0be10f12fda8/30c0d33fdd4ad02356c73067aedcaddc228bcaca8be500ecf84edbd44ffb6b39?language=en",
    "status_code": null,
    "mute_notifications": null,
    "id": "1cbf77cb-ed58-40f2-8bb4-0be10f12fda8",
    "code": "S.0000",
    "friendly_message": "The operation is successful.",
    "smart_routing_verification": {
      "status": "successful"
    },
    "refund": {
      "message": "Refund was approved",
      "ref_id": "8889999",
      "rrn": null,
      "auth_code": null,
      "bank_code": "05",
      "gateway_id": 3483,
      "status": "successful"
    }
  }
}