AirbaPay Docs

Интерфейс взаимодействия с брокером

Создание заявки

Адрес:

Тест: https://sapi.airbapay.kz/bg-proxy-general/api/v1/order/pre-create

Прод: https://api.airbapay.kz/bg-proxy-general/api/v1/order/pre-create

Поле	Детали	Пример	Решение
Метод	POST
Описание	Создание предзаявки по брокеру
URL	order/pre-create
Авторизация	Bearer Token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 .eyJzeXN0ZW0iOiJtZXJjaGFudCIsImV4cCI6MTU5NjU4NTk5Mywic 3ViIjoiYnJva2VyLWdvb2RzIn0 .Jq2xffP0Z0acliHYK8ImPEtevxncKhzV0u_awPRZH7s
Формат ответа	JSON
Статус ответа	200 В случае успешного сценария	{ "orderId": "BGR483", "redirectUrl": "http://sshop.airbapay.kz/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }
	400 В случае ошибки в запросе	{ "code": 400, "message": "Неверные входные данные", "status": "Bad Request" }	Запрос имеет неправильные входные данные, проверить правильно ли заполнен запрос
	401 Ошибка авторизации	{ "code": 401, "message": "token: token does not have permission to perform this action", "status": "Access Denied/Forbidden." }	токен либо отсутствует в заголовке либо токен не валиден (истек срок жизни токена). Получите новый токен или проверить есть ли токен в Authorization header-e
	500 Неизвестная ошибка	{ "code": 500, "message": "Внутренняя ошибка сервера", "status": "Internal Server Error" }	обратитесь за помощью к команде AirbaPay

Описание полей

Заявка - это основной документ для работы с брокером. На основе него отправляются заявки в наши банки партнеры для получения кредитных предложений. Поэтому очень важна правильность ее заполнения. Заявка представляет из себя json документ со следующими полями:

Поле	Тип	Описание	Обязательно	Формат	Пример
delivery	string	Адрес доставки	Да	Город, Адрес	"Алматы, подъезд 1, улица Кожамкулова, кв. 11, 1 этаж"
pickupPoint	string	Адрес самовывоза	Да	Город, Адрес	Алматы, пр. Райымбека, 221 «Ж»
callbackUrl	string	url сервиса update-merchant-order-state на стороне партнера	Да	your-base-url/api/update-status	https://www.airbapay.kz/api/update-status
channel	string	Канал вызова сервиса: mob/web/android/ios	Да	web / mob / android / ios	web
mobile	string	Номер телефона клиента: формат: 7771234567	Да	10 цифр, без +7, без дефисов или скобок	7071234567
failureBackUrl	string	url для возврата клиента на сторону магазина при неудачном исходе сценария	Нет	your-base-url/api/failureBackUrl	https://www.airbapay.kz/failureBackUrl
brand	string	Бренд товара	Да	[A-Za-z0-9]+	xiaomi
category	string	Категория товара	Да	[A-Za-z0-9]+	smartfony
image	string	Ссылка на изображение товара	Нет	https://your-img-url	https://api.airba.kz/f3/api/v1/f3-airba-marketplace-prod/998d66f2-376a-431a-9942-a30526e8ccd0
merchantName	string	Наименование магазина (можно указать код партнера в кредитном брокере который предоставляет команда AirbaPay)	Да	[a-z0-9_]+	merchant merchant_online
model	string	Наименование товара	Да	Кириллица, Латиница	Смартфон GSM Xiaomi Poco F3 256/8GB THX-MD-6.67-48-4 Night Black
price	integer	Цена товара	Да	>4000	299990
quantity	integer	Количество товара	Да	>0	1
sku	string	Артикул товара	Да	>0	1914
isDelivery	boolean	доставка	Да	true, false	true
orderId	string	Номер заказа в магазине. Его следует делать читабельным для людей по типу TGT612 или 1005	Да	[A-Z0-9]+	TGR1234
paymentPartners	array	Список финансовых партнеров в которые необходимо сформировать в заявку.	Да	Ее нужно получить по хендлеру order/payment-partners	[{ "code": "airba", "name": "Airba" }]
salesCode	string	Код партнера в системе AirbaPay (предоставляется командой AirbaPay)	Да	[a-z0-9_]+	merchant merchant_online
salesPlace	string	Почтовый индекс места доставки или самовывоза. Достаточно индекса города старого образца (для Алматы 050000)	Да	[0-9]+	050000
successBackUrl	string	url для возврата клиента на сторону магазина при удачном исходе сценария	Да	https://your-base-url/successBackUrl	https://www.airbapay.kz/successBackUrl
totalCost	integer	Общая цена заказа	Да	>4000	199990
loanLength	integer	Срок займа * (для получения всех предложений и отправьте 0)	Да	>4000	24
productType	string	Тип займа * (для получения всех предложений и отправьте "")	Да	loan/installment	installment

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

json

{
  "address": {
    "delivery": "Алматы, подъезд 1, улица Кожамкулова, кв.11, 1 этаж",
    "pickupPoint": "Алматы, пр. Райымбека, 221 «Ж»"
  },
  "callbackUrl": "https://www.airbapay.kz/successCallback",
  "channel": "web|mob|android|ios",
  "customer": {
    "contact": {
      "mobile": "7071234567"
    }
  },
  "failureBackUrl": "https://www.airbapay.kz/failureBackUrl",
  "goods": [
    {
      "brand": "xiaomi",
      "category": "smartfony",
      "image": "https://api.airba.kz/f3/api/v1/f3-airba-marketplace-prod/998d65f2-376a-431a-9942-a30526e8ccd0",
      "merchantName": " 1",
      "model": "Смартфон GSM Xiaomi Poco F3 256/8GB THX-MD-6.67-48-4 Night Black",
      "price": 299990,
      "quantity": 1,
      "sku": "1914"
    }
  ],
  "isDelivery": true,
  "loanLength": 12,
  "orderId": "TGR1234",
  "paymentPartners": [
    {
      "code": "airba",
      "name": "Airba"
    }
  ],
  "productType": "loan|installment",
  "salesCode": "ABC1",
  "salesPlace": "050000",
  "successBackUrl": "https://www.airbapay.kz/successBackUrl",
  "totalCost": 199990
}

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

json

{
    "code": 200,
    "message": "Заявка успешно создана",
    "redirectUrl": "https://ff.kz/order",
    "status": "OK"
}

Интерфейс взаимодействия с брокером ​

Создание заявки ​

Описание полей ​

Интерфейс взаимодействия с брокером

Создание заявки

Описание полей