Skip to content

Charge

Сервис Charge используется для списания заблокированных денежных средств с карты Покупателя. Выполняется в рамках

При инициализации платежа передается обязательный параметр “auto_charge”.

Если значение было 1, то данный запрос по подтверждению платежа совершать не требуется.

Если значение было 0 и/или в в вебхуке по платежу был статус “auth”, то подтверждение платежа вызывать необходимо. В остальных случаях данный этап можно пропустить. Можно совершить списание частичной суммы, оставшиеся сумма будет возвращена на карту.

В settlement необходимо передавать новое распределение сумма по компаниям. Общая сумма распределений должна быть равна сумме подтверждения платежа.

Для вызова сервиса подтверждения платежа необходимо авторизоваться с payment_id. В payment_id указать ID платежа в платежной системе, который вернул сервис создания платежа.

Сервис при успешном ответе ничего не возвращает.

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

URL base_url/api/v1/payments/charge

Method PUT

ПараметрТипОписание
amountnumberСумма платежа/заказа. Уточнение: Если сумма не указана, то спишется полная сумма платежа при создании. Если указали сумму меньше полной стоимости, то будет списана указанная сумма, а оставшаяся часть будет возвращена на карту покупателя. Пример: 10, 200.20
cartobjectИзмененная корзина
  – goodsarrayТовары в корзине
      — brand*stringМарка
      — model*stringМодель(Наименование)
      — category*stringКатегория
      — price*numberЦена
      — quantity*integerКоличество
      — discount*numberСкидка на товар в процентах
settlementobjectРаспределение платежа по компаниям
  – payments*arrayПлатежи
      — company_id*stringID компании ИИН/БИН компании, который прошел комплаенс.
      — amount*numberСумма
json
{
{
	"amount":350,
	"cart":{
		"goods":[
			{
				"brand":"Tess",
				"category": "Черный чай",
        				"discount": 5,
        				"model": "Чай Tess Banana Split",
			        "price": 350,
			        "quantity": 1
			}
		]
	}
}

Параметр ответа при коде состояния HTTP 200

ПараметрТипОписание
statusstringТекущий статус платежа

Пример ответа:

json
{
	"status": "success"
}