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

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

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

Запрос

Отправьте POST запрос на https://gateway.bepaid.by/transactions/refunds с параметрами из таблиц ниже.

Параметры заголовка запроса
Content-Type
обязательный
 application/json
Accept
обязательный
 application/json
X-API-Version
 Возможные значения: 2, 3. По умолчанию, 3. Подробнее здесь
RequestID
 Ключ идемпотентности. Подробнее здесь.

Параметры тела запроса
object
parent_uid
обязательный
 string
UID транзакции оплаты или списания средств.
amount
обязательный
 integer
Сумма возврата в минимальных денежных единицах, например 1000 для $10.00.
reason
обязательный
 string (255)
Причина возврата.
tracking_id
 string (255)
ID транзакции в системе торговца. Используйте уникальное значение. Если tracking_id не передан, в ответе возвращается tracking_id соответствующей транзакции оплаты/списания при условии, что параметр был передан в запросе на оплату/списание.
object
Секция, содержащая дополнительную информацию о транзакции.
referer
 string
URL ресурса, с которого осуществляется запрос на проведение транзакции. Уточните у службы технической поддержки, является ли этот параметр обязательным для вашего эквайера.

Warning

Если интеграция поддерживает несколько частичных возвратов для одной транзакции оплаты/списания средств, каждый запрос на создание возврата рассматривается как отдельная транзакция.

Если после отправки запроса получен ответ 5xx или произошла сетевая ошибка, рекомендуется проверить статус транзакции по tracking_id. Если транзакция не найдена, повторите исходный запрос с тем же ключом идемпотентности.

Повторный запрос без ключа идемпотентности или с новым ключом идемпотентноти может привести к созданию дополнительного частичного возврата.

Пример запроса 
{
  "request":{
    "parent_uid":"1-310b0da80b",
    "amount":50,
    "reason":"Client request",
    "tracking_id": "123a",
    "additional_data": {
      "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}
Ответ
object
uid
обязательный
 string
UID обработанной транзакции.
status
обязательный
 string
Статус обработанной транзакции.
message
обязательный
 string
Сообщение о результате обработки запроса, соответствующее коду результата обработки транзакции (code). Для отдельных вариантов интеграции данный параметр содержит сообщение от системы эквайера.
amount
 bigInteger
Сумма возврата.
currency
 string
Валюта транзакции в формате ISO-4217 alpha-3 code. Например, USD.
parent_uid
 string
UID родительской транзакции.
type
обязательный
 string
Тип транзакции.
receipt_url
обязательный
 string
Ссылка на квитанцию обработанной транзакции.
created_at
 string
Дата и время создания транзакции в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ.
updated_at
 string
Дата и время последнего обновления транзакции в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ.
paid_at
 string
Дата и время завершения транзакции в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ. Устанавливается в значении null, если транзакция имеет статус incomplete.
settled_at
 string
Дата и время перечисления суммы транзакции на счет торговца в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ. Устанавливается в значении null, если параметр не применим к транзакции.
psp_settled_at
 string
Дата и время расчета по транзакции между системой bePaid и торговцем в формате ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ. Устанавливается в значении null, если параметр не применим к транзакции.
object
Секция с данными о прохождении проверок транзакции сервисом Умная Маршрутизация.
status
 string
Статус обработки транзакции сервисом.
object
Секция, содержащая дополнительную информацию о транзакции.
referer
 string
URL ресурса, с которого осуществляется запрос на проведение транзакции.
code
обязательный
 string
Код обработки транзакции.
friendly_message
обязательный
 string
Сообщение о результате обработки запроса для покупателя, соответствующее коду результата обработки транзакции (code). Для отдельных вариантов интеграции данный параметр содержит сообщение от системы эквайера.
object
message
 string
Сообщение от системы банка.
ref_id
 string
Номер транзакции в системе банка.
rrn
 string
Номер транзакции в международной платёжной системе. ID транзакции, выданный сетью обработки карт.
auth_code
 string
Код авторизации.
gateway_id
 string
Идентификатор платёжного шлюза, который обработал транзакцию, в системе bePaid.
status
string
Статус обработанной транзакции.
Пример ответа 
{
  "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://merchant.bepaid.by/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"
    },
    "additional_data": {
        "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}