О возврате платежа

Дополнение к уведомлению по платежам

Данное уведомление отправляется по факту выполнения сценария - возврат денежных средств по платежу.
Отличия от уведомления о платеже:

- к адресу уведомления добавляется "/refund", после указания ID платежа;
- упрощенная структура сообщения (см. входные параметры).

Платежный шлюз со своей стороны предоставляет список IP адресов (если требуется), с которых могут быть отправлены уведомления.

Дополнительную проверку подлинности сообщения можно выполнить с помощью запроса: информация о платеже. Но если используется протокол http, то необходимо проводить дополнительную проверку.

Входные параметры

Заголовок запроса

POST
Endpoint: {merchant_parameter}/{paymentId}/refunded HTTP/1.1
Content-Type: application/json

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

Поле	Тип	Обяз.	Описание
paymentId	int64	да	ID платежа

Тело запроса

Поле	Тип	Обяз.	Описание
paymentId	int64	да	Идентификатор родительского платежа
operationId	int64	да	Идентификатор операции
amount	amount	да	Сумма возврата
operationDate	dateTime	да	Время проведения операции
loyalty	object	нет	Данные о программе лояльности, которая была использована в платеже
providerParams	object	да	Набор данных от провайдера

Описание структуры loyalty

Поле	Тип	Обяз.	Описание
amount	amount	да	Сумма баллов возврата по программе лояльности пользователя

Описание структуры providerParams

Поле	Тип	Обяз.	Описание
paymentToolInfo	object	нет	Информация с выбранным способом оплаты
processing	object	нет	Набор параметров ПЦ ЭК

Описание структуры paymentToolInfo

Поле	Тип	Обяз.	Описание
type	string(enum)	да	Тип способа оплаты

Описание структуры processing

Поле	Тип	Обяз.	Описание
id	string	нет	ID процессинговой системы, которая проводит refund
rrn	string	нет	RRN Банка
approvalCode	string	нет	Код авторизации
serviceParams{}	object	нет	Набор пар "параметр":"значение", описывающих реквизиты платежа (специфичных для каждого поставщика)

Выходные параметры

Заголовок ответа

Content-Type: application/json; charset=utf-8
http-code: 200
http-status: OK

Тело ответа

Поле	Тип	Обяз.	Описание
result	string	да	SUCCESS\|ERROR
errorMessage	string	нет	Если result=ERROR

Пример

Заголовок запроса

POST {merchant_parameter}/223205/refunded HTTP/1.1
Host:
Content-Type: application/json

Тело запроса

{
  "paymentId" : 223205,
  "operationId": 444450,
  "amount" : 4.3,
  "operationDate" : "2021-05-05T13:07:46.955962",
  "loyalty": {
    "amount": 13.4
  },
  "providerParams": {
    "processing": {
      "id": "123456",
      "rrn": "228416787387",
      "approvalCode": "816622",
      "serviceParams" : {
        "id1" : "108882256562",
        "NUMBER" : "79157802494",
        "payerEmail" : "test@mts.ru"
      }
    },
    "paymentToolInfo": {
      "type" : "newCard"
    }
  }
}

Заголовок ответа

Content-Type: application/json; charset=utf-8
http-code: 200
http-status: OK

Тело ответа

{
  "result":"SUCCESS"
}