Payment v2
При создании платежа по сохраненной карте необходимо передать параметр "card_id", то есть ID сохраненной карты, который был передан в вебхук платежа или в ответе на запрос на добавления карты.
Если в Airba Pay сохранен токен карты от банка-эквайера, то платеж будет проведен автоматически без необходимости ввода CVV (безакцептно). В ответе на запрос вы получите статус платежа.
Если карта не сохранена на стороне банка-эквайера, то в ответе будет статус new и ссылка на платежную форму для ввода данных карты.
Параметры запроса
URL base_url/api/v2/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":"78",
"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 |
| status | string | Статус платежа new - платеж создан auth - платеж авторизован success - платеж успешен secure3D - платеж в 3ds error - платеж ошибочный |
| redirect_url | string | Если статус платежа “new” то нужно перенаправить покупателя на URL платежной формы, для ввода данных карты. |
Примеры ответов
json
{
"id": "63eae27b42498c19945fd82a",
"invoice_id": "78",
"status": "new",
"redirect_url": "https://pf.airbapay.kz/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NzYzNDQ5ODcsImlzX3JlZnJlc2giOmZhbHNlLCJwYXltZW50X2lkIjoiNjNlYWUyN2I0MjQ5OGMxOTk0NWZkODJhIiwidGVybWluYWxfaWQiOiI2M2U3MmJmYTI2ZDg2MDJhMGM2N2U0ZTgifQ.rOy-1AaTtcN-OsFlr0ZxBdJMu1kTsYcDPMCoGkLN_u0"
}json
{
"id": "63eae27b42498c19945fd82a",
"invoice_id": "78",
"status": "success"
}