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

Информация

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

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

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

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

Для получения тестового доступа необходимо:

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

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

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

Важно

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

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

HTTP

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

{
    "amount": 50000
}

cURL

curl --location --request POST 'https://stage-api.ioka.kz/v2/orders' \
--header 'API-KEY: eyJ0eXAiOiJKV1..' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 50000
}'

Python

import requests
import json

url = "https://stage-api.ioka.kz/v2/orders"

payload = json.dumps({
    'amount': 10000
})
headers = {
    'API-KEY': 'eyJ0eXAiOiJKV1..',
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers, data=payload)
order = response.json()['order']

print(order['checkout_url'])

PHP

<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://stage-api.ioka.kz/v2/orders');
$request->setRequestMethod('POST');
$body = new http\Message\Body;
$body->append('{
    "amount": 10000
}');
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
  'API-KEY' => 'eyJ0eXAiOiJKV..',
  'Content-Type' => 'application/json'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

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

{
    "id": "ord_test",
    "shop_id": "shp_test",
    "status": "UNPAID",
    "created_at": "2022-01-01T10:00:00.00000",
    "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_test_secret_f35ec68f34cf780aa2537be74c3e5f241c0a4261a1b59ac524cb42e8eb4c0ad6",
    "checkout_url": "https://stage-checkout.ioka.kz/orders/ord_test",
    "payments": []
}

Шаг 2: Перенаправьте клиента на платежную форму

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

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

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

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

Если пользователь передумает платить или что-то пойдет не так, заказ останется в статусе UNPAID.

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

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

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

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

Важно!

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