Перейти к основному содержимому

Быстрый старт

Информация

Здесь вы можете начать интеграцию вашего магазина с ioka API и принять свой первый тестовый платеж.

Подготовка к интеграции

Чтобы начать работать с ioka, вам нужно зарегистрироваться, получить доступ к личному кабинету, и создать свой первый магазин для принятия платежей. Для аутентификации, вам нужно получить в личном кабинете ключи доступа к API для вашего магазина.

Прежде чем начать принимать реальные платежи, вы можете проверить свою интеграцию в тестовом магазине. При оплате в тестовом магазине все проходит, как при настоящих платежах, но деньги никуда не переводятся.

Для тестирования:

  1. Создайте тестовый магазин в личном кабинете.
  2. Получите ключ доступа - API Key.
  3. Используйте следующий адрес в запросах к API:
https://stage-api.ioka.kz

Шаг 1: Создайте заказ

Заказ — главная сущность в ioka API. В заказе хранятся данные о товарах или услугах, которые необходимо оплатить. Для создания заказа необходимо указать сумму в минорных денежных единицах. Например, для создания заказа на сумму 500 тенге, необходимо ввести 50000 (1 тенге = 100 тиын). Остальные параметры необязательны, но помогут дополнить заказ и описать процесс оплаты.

Важно!

Все запросы к ioka API необходимо отправлять с вашего сервера. Для взаимодействия с ioka API вы можете использовать готовые серверные SDK.

Пример запроса на создание заказа:

POST /v2/orders HTTP/1.1
Host: stage-api.ioka.kz
API-KEY: eyJ0eXAiOiJKV1..
Content-Type: application/json

{
"amount": 50000
}

Шаг 2: Перенаправьте клиента на страницу оплаты

В теле ответа от ioka API вы получите созданный объект заказа в статусе UNPAID. Для оплаты перенаправьте пользователя на адрес checkout_url на стороне ioka, где находится форма сбора карточных данных.

Пример созданного объекта заказа:

{
"id": "ord_ORDERID",
"shop_id": "shp_SHOPID",
"status": "UNPAID",
"created_at": "2022-05-05T11:12:47.687859",
"amount": 50000,
"currency": "KZT",
"mcc": null,
"capture_method": "MANUAL",
"external_id": null,
"description": null,
"extra_info": null,
"attempts": 10,
"due_date": null,
"customer_id": null,
"card_id": null,
"back_url": null,
"success_url": null,
"failure_url": null,
"template": null,
"access_token": "ord_ILJ4iFcMi8_secret_f35ec68f34cf780aa2537be74c3e5f241c0a4261a1b59ac524cb42e8eb4c0ad6",
"checkout_url": "https://stage-checkout.ioka.kz/orders/ord_ORDERID",
"payments": []
}

Если вы создаете платеж для тестового магазина, для оплаты используйте одну из тестовых карт, например pan=555555555555559, expiry_date=12/24, cvc=123

Шаг 3: Получите результат оплаты

Заказ можно считать успешным, как только он перешел в статус PAID или ON_HOLD в зависимости от способа списания денег. Если пользователь передумает платить или что-то пойдет не так, заказ останется в статусе UNPAID.

Чтобы узнать статус платежа, подпишитесь на уведомления от ioka.

Также вы можете следить за статусом, запрашивая информацию о заказе с удобной для вас периодичностью. Для этого вам понадобится идентификатор заказа — значение параметра id в созданном объекте заказа.

Ура, вы приняли первый платеж!

В этом примере описан базовый сценарий интеграции для принятия платежа, где карточные данные собираются на стороне ioka. Если для ваших задач он не подходит, вы можете выбрать один из других сценариев интеграции.

Важно!

Помните, что для приема реальных платежей нужно использовать API ключ боевого магазина.