Payment v1
При создании платежа по сохраненной карте необходимо передать параметр "card_id", то есть ID сохраненной карты, который был передан в вебхук платежа или в ответе на запрос на добавления карты. После перенаправления на платежную форму, клиент увидит замаскированный вид своей карты. Чтобы завершить платеж, ему потребуется ввести код CVV, который находится на обратной стороне карты.
Параметры запроса
URL base_url/api/v1/payments/{cardId}
Method POST
cardId - ID сохраненной карты
Параметр | Тип | Описание |
---|---|---|
invoice_id* | string | Номер заказа в системе продавца. Отображается покупателю в процессе оплаты. Данное поле уникальное в рамках одного терминала. Пример: APay_123 |
amount* | number | Сумма платежа/заказа. Пример: 10, 200.20 |
currency* | string | Валюта. Пример: KZT |
description | string | Описание платежа/заказа |
auto_charge* | integer | Признак одностадийного или двухстадийного платежа. 0 - не списывать средства (двухстадийный платеж) 1 - списать средства после успешной блокировки (одностадийный платеж) |
account_id* | string | Аккаунт покупателя в системе продавца. Можно указывать любое значение. Пример: 77017576252, at@email.com, user34 |
phone* | string | Номер телефона покупателя Формат: 7xxxyyyyyyy Пример: 77017576252 |
email* | string | Email покупателя Пример: at@email.com |
language* | string | Язык интерфейса платежной формы. ru - Русский en - Английский kz - Казахский |
success_back_url* | string | URL возврата в магазин при успехе |
failure_back_url* | string | URL возврата в магазин при ошибке |
success_callback* | string | URL вебхука при успехе |
failure_callback* | string | URL вебхука при ошибке |
cart | object | Корзина При передаче данного параметра, параметры ниже обязательны. |
– goods | array | Товары в корзине |
— brand* | string | Марка |
— model* | string | Модель (Наименование) |
— category* | string | Категория |
— price* | number | Цена |
— quantity* | integer | Количество |
— discount* | number | Скидка на товар в процентах |
settlement | object | Распределение платежа по компаниям |
– payments* | array | Платежи |
— company_id* | string | ID компании ИИН/БИН компании, который прошел комплаенс. |
— amount* | number | Сумма |
add_parameters | object | Дополнительные параметры для платежной формы. |
– payform | object | Настройки отображения и запросов для платёжной формы. |
— render_apple_pay | boolean | Отображение опции Apple Pay. Если значение true, то опция будет отображена на платёжной форме. |
— render_google_pay | boolean | Отображение опции Google Pay. Если значение true, то опция будет отображена на платёжной форме. |
— render_save_cards | boolean | Отображение списка сохраненных карт. Если значение true, то пользователь сможет увидеть список сохраненных карт для оплаты. |
— request_cvv | boolean | Запрос CVV-кода карты. Если значение true, то пользователь должен будет ввести CVV-код для подтверждения платежа. |
— request_face_id | boolean | Запрос Face ID для подтверждения платежа. Если значение true, то пользователь сможет подтвердить платёж с использованием Face ID. |
json
{
"invoice_id":"77",
"amount":354,
"currency":"KZT",
"description":"description",
"email":"client@gmail.com",
"phone":"+77071230123",
"language":"RU",
"success_back_url":"https://success_back_url",
"failure_back_url":"https://failure_back_url",
"success_callback":"https://success_callback",
"failure_callback":"https://failure_callback"
}
Параметр ответа при коде состояния HTTP 201
Параметр | Тип | Описание |
---|---|---|
id | string | ID платежа в Airba Pay.Данный ID необходимо передать в сервис авторизации, он обязателен для операций над платежами. Пример: 63eae27b42498c19945fd82a Уточнение: запрос статуса, возврат. |
invoice_id | string | Номер заказа в системе продавца. Пример: APay_123 |
redirect_url | string | URL платежной формы, куда нужно перенаправить покупателя для ввода данных карты |
Пример запроса с payment_id:
json
{
"user":"merchant",
"password":"777",
"terminal_id":"asa2323d7sda733dwdq",
"payment_id":"63eae27b42498c19945fd82a"
}