Skip to content

Payments

После успешного запроса инициализации платежа Authorization, пользователь переходит на платежную форму Airba Pay.

Время для ввода данных карты после создания платежа по умолчанию 30 минут. Также это время настраивается на стороне Airba Pay.

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

URL base_url/api/v1/payments

Method POST

ПараметрТипОписание
invoice_id*stringНомер заказа в системе продавца. Отображается покупателю в процессе оплаты. Данное поле уникальное в рамках одного терминала. Пример: APay_123
amount*numberСумма платежа/заказа. Пример: 10, 200.20
currency*stringВалюта. Пример: KZT Примечание: на данный момент только KZT
descriptionstringОписание платежа/заказа
auto_charge*integerПризнак одностадийного или двухстадийного платежа. 0 - не списывать средства (двухстадийный платеж) 1 - списать средства после успешной блокировки (одностадийный платеж)
card_save*booleanПризнак сохранение карты. false - Карту не сохранять true - Карту сохранить Уточнение: Если карта сохранена, в вебхук будет передан параметр "card_id".
account_id*stringАккаунт покупателя в системе продавца. Можно указывать любое значение. Пример: 77017576252, at@email.com, user34
phone*stringНомер телефона покупателя Формат: 7xxxyyyyyyy Пример: 77017576252
email*stringEmail покупателя Пример: at@email.com
language*stringЯзык интерфейса платежной формы. ru - Русский en - Английский kz - Казахский
success_back_url*stringURL возврата в магазин при успехе
failure_back_url*stringURL возврата в магазин при ошибке
success_callback*stringURL вебхука при успехе
failure_callback*stringURL вебхука при ошибке
cartobjectКорзина При передаче данного параметра, параметры ниже обязательны.
  goodsarrayТовары в корзине
      brand*stringМарка
      model*stringМодель (Наименование)
      category*stringКатегория
      price*numberЦена
      quantity*integerКоличество
      discount*numberСкидка на товар в процентах
settlementobjectРаспределение платежа по компаниям
  payments*arrayПлатежи
      company_id*stringID компании ИИН/БИН компании, который прошел комплаенс.
      amount*numberСумма
add_parametersobjectДополнительные параметры для платежной формы.
 payformobjectНастройки отображения и запросов для платёжной формы.
   render_apple_paybooleanОтображение опции Apple Pay. Если значение true, то опция будет отображена на платёжной форме.
   render_google_paybooleanОтображение опции Google Pay. Если значение true, то опция будет отображена на платёжной форме.
   render_save_cardsbooleanОтображение списка сохраненных карт. Если значение true, то пользователь сможет увидеть список сохраненных карт для оплаты.
   request_cvvbooleanЗапрос CVV-кода карты. Если значение true, то пользователь должен будет ввести CVV-код для подтверждения платежа.
   request_face_idbooleanЗапрос Face ID для подтверждения платежа. Если значение true, то пользователь сможет подтвердить платёж с использованием Face ID.
json
{
	"invoice_id":"77",
	"amount":100,
	"currency":"KZT",
	"description":"description",
	"email":"client@gmail.com",
	"phone":"+77071230123",
	"language":"ru",
	"account_id":"77071230123",
	"card_save": true,
	"auto_charge":0,
	"success_back_url":"https://success_back_url",
	"failure_back_url":"https://failure_back_url",
	"success_callback":"https://aisarov.kz/rest-message.php",
	"failure_callback":"https://aisarov.kz/rest-message.php",
	"cart":{
		"goods":[
			{
				"brand":"Tess",
				"category": "Черный чай",
        "discount": 5,
        "model": "Чай Tess Banana Split черный 20 пирамидок",
        "price": 4240,
        "quantity": 1
			}
		]
	},
      "settlement":{
         "payments":[
		{
			«company_id":"000000000001",
			«amount":123
		}
         ]
      }
}

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

ПараметрТипОписание
idstringID платежа в Airba Pay. Данный ID необходимо передать в сервис авторизации, он обязателен для операций над платежами. Пример: 63eae27b42498c19945fd82a Уточнение: запрос статуса, возврат.
invoice_idstringНомер заказа в системе продавца. Пример: APay_123
redirect_urlstringURL платежной формы, куда нужно перенаправить покупателя для ввода данных карты

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

json
{
	"id": "63eae27b42498c19945fd82a",
	"invoice_id": "77",
	"redirect_url": "https://pf.airbapay.kz/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NzYzNDQ5ODcsImlzX3JlZnJlc2giOmZhbHNlLCJwYXltZW50X2lkIjoiNjNlYWUyN2I0MjQ5OGMxOTk0NWZkODJhIiwidGVybWluYWxfaWQiOiI2M2U3MmJmYTI2ZDg2MDJhMGM2N2U0ZTgifQ.rOy-1AaTtcN-OsFlr0ZxBdJMu1kTsYcDPMCoGkLN_u0"
}