Appearance
Charge
Сервис Charge используется для списания заблокированных денежных средств с карты Покупателя. Выполняется в рамках
При инициализации платежа передается обязательный параметр “auto_charge”.
Если значение было 1, то данный запрос по подтверждению платежа совершать не требуется.
Если значение было 0 и/или в в вебхуке по платежу был статус “auth”, то подтверждение платежа вызывать необходимо. В остальных случаях данный этап можно пропустить. Можно совершить списание частичной суммы, оставшиеся сумма будет возвращена на карту.
В settlement необходимо передавать новое распределение сумма по компаниям. Общая сумма распределений должна быть равна сумме подтверждения платежа.
Для вызова сервиса подтверждения платежа необходимо авторизоваться с payment_id. В payment_id указать ID платежа в платежной системе, который вернул сервис создания платежа.
Сервис при успешном ответе ничего не возвращает.
Параметры запроса
URL https://ps.airbapay.kz/acquiring-api/api/v1/payments/charge
Method PUT
| Параметр | Тип | Описание |
|---|---|---|
| amount | number | Сумма платежа/заказа. Уточнение: Если сумма не указана, то спишется полная сумма платежа при создании. Если указали сумму меньше полной стоимости, то будет списана указанная сумма, а оставшаяся часть будет возвращена на карту покупателя. Пример: 10, 200.20 |
| cart | object | Измененная корзина |
| – goods | array | Товары в корзине |
| — brand* | string | Марка |
| — model* | string | Модель(Наименование) |
| — category* | string | Категория |
| — price* | number | Цена |
| — total_price* | float64 | Общая сумма товара |
| — quantity* | integer | Количество |
| — discount* | number | Скидка на товар в процентах |
| — company_id* | string | ID компании ИИН/БИН компании, который прошел комплаенс. |
| — good_discount | object | Скидка на определенный товар в корзине. При передаче данного параметра, параметры ниже обязательны |
| — name* | string | Короткое описание - (отобразится в чеке) |
| — quantity* | int | Количество |
| — amount* | float64 | Сумма скидки |
| — total_amount* | float64 | Общая сумма скидки |
| discounts | array | Общая скидка на всю корзину. Например, сертификат. При передаче данного параметра, параметры ниже обязательны. |
| – name* | string | Короткое описание - отобразится в чеке |
| – quantity* | int | Количество |
| – amount* | float64 | Сумма скидки |
| – total_amount* | float64 | Общая сумма скидки |
| settlement | object | Распределение платежа по компаниям |
| – payments* | array | Платежи |
| — company_id* | string | ID компании ИИН/БИН компании, который прошел комплаенс. |
| — amount* | number | Сумма |
json
{
{
"amount":350,
"cart":{
"goods":[
{
"brand":"Tess",
"category": "Черный чай",
"discount": 5,
"model": "Чай Tess Banana Split",
"price": 350,
"quantity": 1
}
]
}
}Параметр ответа при коде состояния HTTP 200
| Параметр | Тип | Описание |
|---|---|---|
| status | string | Текущий статус платежа |
Пример ответа:
json
{
"status": "success"
}