Return
Данный сервис может разблокировать средства, если платеж в статусе “auth”
только всю сумму, и оформить возврат, если платеж в статусе “success”
всю или частичную сумму. Для вызова сервиса Return платежа необходимо авторизоваться с payment_id. В payment_id указать ID платежа в платежной системе, который вернул сервис создания платежа.
В settlement необходимо передавать новое распределение сумма по компаниям
Параметры запроса
URL base_url/api/v1/payments/return
Method DELETE
Параметр | Тип | Описание |
---|---|---|
ext_id | string | ID возврата внешней системы Необязательный параметр, но если он задан то для ext_id будет работать идемпотентность |
amount | number | Сумма возврата. Если сумма не указана, то подтвердится полная сумма платежа при создании. Если сумма меньше полной стоимости, то будет возвращена указанная сумма. Пример: 100, 123.44 |
cart | object | Измененная корзина |
goods | array | Товары в корзине |
brand* | string | Марка |
model* | string | Модель (Наименование) |
category* | string | Категория |
price* | number | Цена |
quantity* | integer | Количество |
discount* | number | Скидка на товар в процентах |
reason | string | Причина возврата |
settlement | object | Распределение платежа по компаниям |
payments* | array | Платежи |
company_id* | string | ID компании ИИН/БИН компании, который прошел комплаенс. |
amount* | number | Сумма |
json
{
"ext_id": "2323ssdsd23dfsfsdf",
"amount":350,
"cart":{
"goods":[
{
"brand":"Tess",
"category": "Черный чай",
"discount": 5,
"model": "Чай Tess Banana Split",
"price": 350,
"quantity": 1
}
]
},
"reason":"Клиент вернул товар"
}
Параметр ответа при коде состояния HTTP 200
Параметр | Тип | Описание |
---|---|---|
id | string | ID возврата платежной системы |
ext_id | string | ID возврата внешней системы |
status | string | Текущий статус платежа |
Пример запроса с payment_id:
json
{
"id": "12klsd23dsds2323",
"ext_id": "2323ssdsd23dfsfsdf",
"status": "success"
}