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

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

Операция полностью или частично возвращает деньги на счет клиента в случае полной или частичной отмены заказа или возврата товара.


Запрос

Для возврата средств отправьте POST запрос на https://api.begateway.com/beyag/transactions/refunds со следующими параметрами:

Параметр Тип Описание
request object
parent_uid * обязательный
string UID родительской транзакции.
reason * обязательный
string Причина возврата.
amount integer Сумма возврата в минимальных денежных единицах, например 1000 для $10.00
tracking_id string ID транзакции или заказа в вашей системе.
Пример запроса
{
  "request":{
    "parent_uid":"1-310b0da80b",
    "reason":"reason",
    "amount": 50
  }
}
Ответ
Параметр Тип Описание
transaction object
uid * обязательный
string UID обработанной транзакции.
parent_uid string UID родительской транзакции.
type * обязательный
string Тип транзакции.
status * обязательный
string Статус обработанной транзакции.
created_at string Время создания транзакции в ISO 8601 формате.
updated_at string Время обновления транзакции в ISO 8601 формате.
message string Сообщение с результатом запроса
amount integer Сумма списания.
tracking_id string ID транзакции или заказа в вашей системе.
test boolean true или false. Транзакция будет тестовой при true
language string Значение параметра language из запроса.
paid_at string Дата проведения транзакции.
method_type string Имя платёжной системы или определённый способ оплаты, поддерживаемый подключенной платёжной системой
receipt_url * обязательный
string Ссылка на квитанцию обработанной транзакции.
refund object
status * обязательный
string Статус обработанной транзакции.
ref_id string Номер операции в платёжной системе.
message string Сообщение от платёжной системы
be_protected_verification object Секция с параметрами проверки beProtected.
Пример ответа
{
  "transaction": {
    "uid": "2-310b0da80b",
    "parent_uid": "1-310b0da80b",
    "type": "refund",
    "status": "successful",
    "message": "The operation was successfully processed",
    "created_at": "2014-06-11T12:04:59+03:00",
    "updated_at": "2014-06-11T12:04:59+03:00",
    "amount": 50,
    "test": false,
    "method_type": ":method_name",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/2-310b0da80b/11443f39ae75aa1f955a9c9283cd5045bfb0413b65d666f834a9da4e7d3926b5",
    "refund": {
      "message": "The operation was successfully processed",
      "ref_id": "8889999",
      "status": "successful"
    }
  }
}
Пример ответа транзакции, успешно прошедшей beProtected проверку
{
  "transaction": {
    "uid": "2-310b0da80b",
    "parent_uid": "1-310b0da80b",
    "type": "refund",
    "status": "successful",
    "message": "The operation was successfully processed",
    "created_at": "2014-06-11T12:04:59+03:00",
    "updated_at": "2014-06-11T12:04:59+03:00",
    "amount": 50,
    "test": false,
    "method_type": ":method_name",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/2-310b0da80b/11443f39ae75aa1f955a9c9283cd5045bfb0413b65d666f834a9da4e7d3926b5",
    "refund": {
      "message": "The operation was successfully processed",
      "ref_id": "8889999",
      "status": "successful"
    },
    "be_protected_verification":{
      "status":"successful",
      "rules":{
        "1_123_My Shop":{
          "more_100_eur" : {"Transaction amount more than 100 AND Transaction currency is EUR": "passed"}
        },
        "1_John Doe":{},
        "Demo PSP":{}
      }
    }
  }
}