Разработчикам

xPay API предоставляет удобные и надежные средства для интеграции платежей с использованием QR‑кодов. Система поддерживает гибкие настройки и интеграцию с внешними сервисами для обработки платежей.

Преимущества XPAY API

Платежные сценарии, которые закрывают и бизнес‑задачи, и UX.

Оплата через любое банковское приложение Кыргызстана

Пользователь может выбрать привычное приложение и оплатить по QR без лишних шагов.

Платежная страница c платежными кнопками банков

Готовая pay‑страница с QR-кодом для оплаты и кнопками для быстрого перехода в банковское приложение.

Динамические и статические QR

Генерируйте QR под каждую оплату или используйте статические с фиксированной суммой для типовых сценариев.

Гибкая настройка платежа для идентификации

Передавайте id плательщика, услуги, сервиса и комментарии для прозрачного учета и связью с вашей системой.

Автоматическое уведомление о статусе платежа

Webhook‑уведомления позволяют сразу обрабатывать поступления в вашей системе без дополнительных запросов.

Редирект на указанную страницу после оплаты

Возвращайте клиента в нужный интерфейс после успешного платежа.

Специально для вас

Бесплатная доработка API под вашу задачу

Если нужен нестандартный сценарий оплаты, мы поможем реализовать логику на нашей стороне и согласуем интеграцию.

Наши клиенты подключают API XPAY за 3 дня

API простое и понятное — интеграция в вашу систему занимает минимум времени.

Ниже – 3 основных шага для получения оплаты по QR‑коду XPAY.

Авторизация

Генерация QR‑кода

Получение статуса

Авторизация

Передайте авторизационные данные в запросе и получите токен доступа. Используйте Bearer‑токен из ответа для последующих запросов.

Тело запроса

POST

{
  "client_id": "<YOUR_CLIENT_ID>",
  "client_secret": "<YOUR_CLIENT_SECRET>"
}

Для разработки мы выдадим вам тестовые авторизационные данные по запросу. Для боевой среды используйте уникальные ключи вашего пользователя. Они доступны в разделе Профиль в Личном кабинете XPAY.

Генерация QR‑кода

Отправьте запрос на создание QR с нужными параметрами и токеном авторизации.

Обязательные поля: uuid и amount.

Заголовки

POST

{
  "Authorization": "Bearer <YOUR_ACCESS_TOKEN>",
  "Accept": "application/json"
}

Тело запроса

POST

{
  "uuid": "985b0981-8e71-41bf-97fd-4e8769e8cd9f",       // id торговой точки
  "type": "dynamic",                                    // тип qr-кода
  "payer_id": "10000000000005",                         // id плательщика
  "service_id": "1",                                    // id сервиса
  "service_name": "MyService",                          // название услуги
  "comments": "Комментарий к платежу",                  // комментарий для qr
  "callback_url": "http://webhook.url",                 // где принимать вебхук
  "return_url": "http://redirect.url",                  // куда переводить после оплаты
  "check_url": "http://confirmation.url",               // где дождаться подтверждения перед разблокировкой qr
  "amount_change": false,                               // можно менять сумму
  "amount": 1000                                        // сумма
}

Ответ

200 OK

{
  "status": "Success",
  "message": "Generate QR Code",
  "data": {
    "qr_transaction_id": "2843595907tv78Stf2coPEXvu",
    "qr_code": "https://pay.xpay.kg#00020101021132450012ab2b.xpay.kg01011101400407202310247120211332900251745226190sa6vxjr52p62ui25204599953034175909Telemedia63044e70",
    "identificator": "29435071778cycy252qj7u29y",
    "type": "dynamic",
    "payer_id": "10000000000005",
    "service_id": "1",
    "service_name": "MyService",
    "comments": "Комментарий к платежу",
    "callback_url": "http://webhook.url",
    "return_url": "http://redirect.url",
    "amount_change": false,
    "request_amount": 1000,
    "amount": 1000,
    "payable": 992
  }
}

Оплата QR‑кода

Любой созданный QR‑код формируется в виде ссылки pay.xpay.kg. Ее можно открыть в браузере, чтобы перейти в банковское приложение или оплатить в 1 клик.

Для мобильных и веб‑сервисов рекомендуется предоставлять пользователю ссылку на pay.xpay.kg вместо трансформации ссылки в QR‑код.

ПЕРЕХОД В БАНКОВСКИЕ ПРИЛОЖЕНИЯСКАЧИВАНИЕ QR В ГАЛЛЕРЕЮМУЛЬТИЯЗЫЧНОСТЬПОДДЕРЖКА РЕДИРЕКТОВ

Статус QR‑кода

Получите статус успешной оплаты через webhook или через отдельный запрос статуса, передав идентификатор транзакции в пути запроса.

Ответ

GET

{
  "status": "Success",
  "message": "Status QR Code",
  "data": {
    "qr_transaction_id": "1734439544EjZ25uVX16UDKxX",
    "pay_status": "COMPLETED",
    "transaction_uuid": "9dc11610-0651-40ee-8459-cabe889fec3x",
    "trx": "467de507-5a4d-4a26-bb95-9bdf7258f300",
    "request_amount": "240.00000000",
    "amount": "235.00000000",
    "payable": "233.12000000",
    "created_at": "2024-11-05T05:20:51.000000Z",
    "executed_time": "2024-12-18 18:50:44"
  }
}

Статусы платежа

ACTIVE

Активен

WAITING

Ожидается оплата

PROCESSING

Обработка

COMPLETED

Успешное завершение

ERROR

Ошибка

CANCELED

Отмена

Хотите получить полную документацию?

Оставьте заявку — мы выдадим документацию и тестовые доступы для интеграции.

Заявка отправлена

Мы скоро свяжемся с вами.