Skip to content

Return

Данный сервис может разблокировать средства, если платеж в статусе “auth” только всю сумму, и оформить возврат, если платеж в статусе “success” всю или частичную сумму. Для вызова сервиса Return платежа необходимо авторизоваться с payment_id. В payment_id указать ID платежа в платежной системе, который вернул сервис создания платежа.

В settlement необходимо передавать новое распределение сумма по компаниям

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

URL base_url/api/v1/payments/return

Method DELETE

ПараметрТипОписание
ext_idstringID возврата внешней системы Необязательный параметр, но если он задан то для ext_id будет работать идемпотентность
amountnumberСумма возврата. Если сумма не указана, то подтвердится полная сумма платежа при создании. Если сумма меньше полной стоимости, то будет возвращена указанная сумма. Пример: 100, 123.44
cartobjectИзмененная корзина
  goodsarrayТовары в корзине
      brand*stringМарка
      model*stringМодель (Наименование)
      category*stringКатегория
      price*numberЦена
      quantity*integerКоличество
      discount*numberСкидка на товар в процентах
reasonstringПричина возврата
settlementobjectРаспределение платежа по компаниям
  payments*arrayПлатежи
      company_id*stringID компании ИИН/БИН компании, который прошел комплаенс.
      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

ПараметрТипОписание
idstringID возврата платежной системы
ext_idstringID возврата внешней системы
statusstringТекущий статус платежа

Пример запроса с payment_id:

json
{
	"id": "12klsd23dsds2323",
	"ext_id": "2323ssdsd23dfsfsdf",
	"status": "success"
}