Tole.
Тіркелу
Әзірлеушілерге · REST API v1v1 келісімшарты

Tole REST API толық құжаттамасы

Live төлемдер, sandbox, кілттер, webhooks, жауаптар және қателер бойынша оқылатын анықтамалық. OpenAPI — осы беттің орнына емес, қосымша машиналық формат.

Жылдам бастау

Base URL: https://api.tolepay.kz/v1. Алғашқы интеграция үшін Kaspi-ге сұрау жібермейтін test кілт пен /sandbox пайдаланыңыз.

1

Sandbox қосылымын жасаңыз

Кабинетте live-тан оқшауланған тест қосылымын жасаңыз.

2

Test API кілтін жасаңыз

Sandbox connection үшін grant пен қажетті permissions беріңіз. Құпия бір рет көрсетіледі.

3

Шот немесе QR жасаңыз

Bearer кілтін, X-Tole-Connection-Id және бірегей Idempotency-Key жіберіңіз.

4

Төлемді модельдеңіз

paid мәртебесімен simulate шақырып, webhook өңдегішін тексеріңіз.

5

Live-қа ауысыңыз

Test кілт пен /sandbox маршруттарын live нұсқасына ауыстырыңыз. Test ID live-қа көшірілмейді.

Kaspi кассирін дайындау

Авторизация және ортақ тақырыптар

Төлем endpoint-терін тек backend-тен шақырыңыз. tole_sk_* мәнін браузерге, мобильді қолданбаға немесе frontend логтарына жібермеңіз.

Authorization

Міндетті. Live үшін Bearer tole_sk_live_v1…, sandbox үшін Bearer tole_sk_test_v1….

Content-Type

Body бар сұраулар үшін application/json.

X-Tole-Connection-Id

Қосылым UUID-і. Негізгі қосылым бар live режимінде міндетті емес; sandbox-та әрқашан міндетті.

Idempotency-Key

Create/cancel/refund үшін міндетті. Бір бизнес сұрау — бір кілт.

Кілт құқықтары таңдалған қосылым үшін тексеріледі. Басқа қосылымға grant қолжетімділік бермейді. Wildcard жоқ.

Read

120 / min

GET и provider reads

Lookup

60 / min

client-info

Mutation

30 / min

create, cancel, refund

Live payment API

Маршруттарды https://api.tolepay.kz/v1 адресіне қосыңыз. operationId және paymentIntentId — Tole жергілікті UUID-лері.

POST/invoices/client-infoШот алушысын тексеру

Kaspi көрсетілген нөмірге шот жібере алатынын тексереді. Клиент аты мен толық телефоны қайтарылмайды.

Авторизация: Bearer API keyPermission: invoice:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
phoneNumberbodystringИәҚазақстан нөмірі: +7 және 10 сан.

Safe өрістер Kaspi жауабына байланысты.

Сұрау үлгісі
curl https://api.tolepay.kz/v1/invoices/client-info \
  -H "Authorization: Bearer $TOLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber":"+77001234567"}'
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "eligible": true }
}
POST/invoicesТелефон арқылы шот жасау

Live Kaspi шотын жасайды. data.id — келесі сұрауларға арналған Tole UUID-і.

Авторизация: Bearer API keyPermission: invoice:createHTTP: 201 Created
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
Idempotency-KeyheaderstringИәMutation үшін бірегей кілт. Сол сұрауды сол кілтпен қайталаңыз.
phoneNumberbodystringИә+7 және 10 сан.
amountbodyintegerИәKZT сомасы: 1–100 000 000.
commentbodystringЖоқМіндетті емес, 200 таңбаға дейін.

receiptUrl және orderNumber міндетті емес.

Сұрау үлгісі
curl https://api.tolepay.kz/v1/invoices \
  -X POST \
  -H "Authorization: Bearer $TOLE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1024-invoice-v1" \
  -d '{"phoneNumber":"+77001234567","amount":5000,"comment":"Order 1024"}'
201 Created · Жауап үлгісі
{
  "ok": true,
  "data": {
    "id": "d7dfb407-0e4c-4cc2-9d31-26d9f696cb27",
    "kind": "invoice",
    "status": "created",
    "amount": 5000,
    "clientPhoneLast4": "4567",
    "receiptUrl": "https://…",
    "orderNumber": "…"
  },
  "commandId": "d7dfb407-0e4c-4cc2-9d31-26d9f696cb27",
  "replayed": false
}
GET/invoices/historyШоттар тарихын алу

Таңдалған қосылымның қауіпсіз шоттар тарихын қайтарады.

Авторизация: Bearer API keyPermission: invoice:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.

Provider өрістері сүзіледі; Kaspi ID жергілікті operationId-ге ауыстырылады.

Сұрау үлгісі
curl https://api.tolepay.kz/v1/invoices/history \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "items": [{ "operationId": "uuid", "amount": 5000, "status": "Processed", "date": "…" }] }
}
GET/invoices/{operationId}Шот деректерін алу

Provider-ден ағымдағы деректерді оқиды.

Авторизация: Bearer API keyPermission: invoice:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
operationIdpathuuidИәTole операциясының жергілікті UUID-і.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/invoices/$OPERATION_ID \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "amount": 5000, "currency": "KZT", "status": "Processed" }
}
POST/invoices/{operationId}/cancelШоттан бас тарту

Бұрын жасалған шоттан бас тартады. Body — бос JSON объект.

Авторизация: Bearer API keyPermission: invoice:cancelHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
Idempotency-KeyheaderstringИәMutation үшін бірегей кілт. Сол сұрауды сол кілтпен қайталаңыз.
operationIdpathuuidИәTole операциясының жергілікті UUID-і.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/invoices/$OPERATION_ID/cancel \
  -X POST \
  -H "Authorization: Bearer $TOLE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1024-cancel-v1" \
  -d '{}'
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "operationId": "uuid", "status": "cancelled" },
  "commandId": "uuid",
  "replayed": false
}
POST/qrДинамикалық QR жасау

Төлем QR-ын жасап, paymentUrl және qrToken қайтарады.

Авторизация: Bearer API keyPermission: qr:createHTTP: 201 Created
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
Idempotency-KeyheaderstringИәMutation үшін бірегей кілт. Сол сұрауды сол кілтпен қайталаңыз.
amountbodyintegerИәKZT сомасы: 1–100 000 000.
latitudebodynumberЖоқМіндетті емес, −90…90; longitude бірге.
longitudebodynumberЖоқМіндетті емес, −180…180; latitude бірге.

expiresAt және receiptUrl міндетті емес.

Сұрау үлгісі
curl https://api.tolepay.kz/v1/qr \
  -X POST \
  -H "Authorization: Bearer $TOLE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1024-qr-v1" \
  -d '{"amount":5000}'
201 Created · Жауап үлгісі
{
  "ok": true,
  "data": {
    "id": "uuid", "kind": "qr", "status": "created", "amount": 5000,
    "paymentUrl": "https://…", "qrToken": "https://qr.kaspi.kz/…",
    "expiresAt": "…", "receiptUrl": "https://…"
  },
  "commandId": "uuid",
  "replayed": false
}
GET/qr/{operationId}QR деректерін алу

Provider-ден QR мәртебесін оқиды.

Авторизация: Bearer API keyPermission: qr:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
operationIdpathuuidИәTole операциясының жергілікті UUID-і.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/qr/$OPERATION_ID \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "amount": 5000, "currency": "KZT", "status": "Processed" }
}
GET/history/operationsОперациялар тарихын алу

UTC күніне дейінгі операциялар тарихы.

Авторизация: Bearer API keyPermission: history:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
endDatequerydateИәМіндетті: YYYY-MM-DD, UTC.
lastTransactionDatequerystringЖоқАлдыңғы жауаптағы cursor.
statementPeriodCodequeryintegerЖоқТеріс емес кезең коды.
Сұрау үлгісі
curl "https://api.tolepay.kz/v1/history/operations?endDate=2026-08-23" \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": {
    "items": [{ "operationId": "uuid", "amount": 5000, "type": "Payment", "status": "Processed" }],
    "lastTransactionDate": "…", "hasMore": false
  }
}
GET/history/operations/{operationId}Тарих операциясын алу

Жергілікті UUID бойынша қауіпсіз деректер.

Авторизация: Bearer API keyPermission: history:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
operationIdpathuuidИәTole операциясының жергілікті UUID-і.
operationMethodqueryintegerЖоқМіндетті емес әдіс коды.
Сұрау үлгісі
curl "https://api.tolepay.kz/v1/history/operations/$OPERATION_ID?operationMethod=0" \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "operationId": "uuid", "amount": 5000, "status": "Processed" }
}
POST/refundsҚайтарым жасау

Ағымдағы қосылым QR төлемін толық не ішінара қайтару.

Авторизация: Bearer API keyPermission: refund:createHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
Idempotency-KeyheaderstringИәMutation үшін бірегей кілт. Сол сұрауды сол кілтпен қайталаңыз.
operationIdbodyuuidИәQR/payment intent жергілікті UUID-і.
returnAmountbodyintegerИәKZT, қолжетімді қалдықтан аспайды.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/refunds \
  -X POST \
  -H "Authorization: Bearer $TOLE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: refund-order-1024-v1" \
  -d '{"operationId":"uuid","returnAmount":1500}'
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "operationId": "uuid", "status": "refund_accepted", "returnAmount": 1500 },
  "commandId": "uuid", "replayed": false
}
GET/payment-intents/invoices/{paymentIntentId}Шоттың сақталған мәртебесін алу

Tole ledger ішіндегі күйді оқиды.

Авторизация: Bearer API keyPermission: invoice:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
paymentIntentIdpathuuidИәTole төлем ниетінің UUID-і.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/payment-intents/invoices/$PAYMENT_INTENT_ID \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": {
    "id": "uuid", "kind": "invoice", "status": "paid", "amount": 5000,
    "refundedAmount": 0, "currency": "KZT", "revision": 3,
    "createdAt": "2026-08-23T10:00:00.000Z", "updatedAt": "2026-08-23T10:01:00.000Z",
    "paidAt": "2026-08-23T10:01:00.000Z", "terminalAt": null, "lastReconciledAt": "…"
  }
}
GET/payment-intents/qr/{paymentIntentId}QR сақталған мәртебесін алу

QR үшін durable payment-intent келісімшарты.

Авторизация: Bearer API keyPermission: qr:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringЖоқLive қосылым UUID-і; негізгі қосылым болса міндетті емес.
paymentIntentIdpathuuidИәTole төлем ниетінің UUID-і.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/payment-intents/qr/$PAYMENT_INTENT_ID \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "id": "uuid", "kind": "qr", "status": "pending", "amount": 5000, "currency": "KZT", "revision": 1 }
}
GET/commands/{commandId}Идемпотентті команданы тексеру

202 не желі қатесінен кейін command нәтижесін тексереді.

Авторизация: Bearer API keyHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
commandIdpathuuidИәcommandId не Location ішіндегі UUID.

Команда connection мен permission мәнін өзі анықтайды.

Сұрау үлгісі
curl https://api.tolepay.kz/v1/commands/$COMMAND_ID \
  -H "Authorization: Bearer $TOLE_API_KEY"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": {
    "commandId": "uuid", "status": "succeeded", "responseStatus": 201,
    "result": { "ok": true, "data": { "id": "uuid" }, "commandId": "uuid" },
    "updatedAt": "2026-08-23T10:00:01.000Z"
  }
}

Sandbox API

Sandbox негізгі келісімшартты қайталайды, командалар мен webhooks жасайды, бірақ Kaspi-ге сұрау жібермейді.

Sandbox айна маршруттары

Live path алдына /sandbox қосыңыз. Сұрау схемалары бірдей, data ішінде sandbox синтетикалық мәндері болады. X-Tole-Connection-Id міндетті.

POST/sandbox/invoices/client-info

invoice:read

POST/sandbox/invoices

invoice:create

GET/sandbox/invoices/history

invoice:read

GET/sandbox/invoices/{operationId}

invoice:read

POST/sandbox/invoices/{operationId}/cancel

invoice:cancel

POST/sandbox/qr

qr:create

GET/sandbox/qr/{operationId}

qr:read

GET/sandbox/history/operations

history:read

GET/sandbox/history/operations/{operationId}

history:read

POST/sandbox/refunds

refund:create

GET/sandbox/commands/{commandId}

permission исходной команды

201 Created · sandbox invoice
{
  "ok": true,
  "data": {
    "id": "uuid", "kind": "invoice", "status": "created", "amount": 5000,
    "clientPhoneLast4": "4567", "orderNumber": "SBX-1234ABCD", "environment": "sandbox"
  },
  "commandId": "uuid", "replayed": false
}
201 Created · sandbox QR
{
  "ok": true,
  "data": {
    "id": "uuid", "kind": "qr", "status": "created", "amount": 5000,
    "paymentUrl": "https://sandbox.tole.test/pay/uuid",
    "qrToken": "https://sandbox.tole.test/qr/uuid", "environment": "sandbox"
  },
  "commandId": "uuid", "replayed": false
}
POST/sandbox/connectionsSandbox қосылымын жасау

API key емес, пайдаланушы JWT қолданады.

Авторизация: Bearer JWTHTTP: 201 Created
ӨрісОрныТүріМіндеттіСипаттама
displayNamebodystringИә1–100 таңбалық атау.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/sandbox/connections \
  -X POST -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"displayName":"Development"}'
201 Created · Жауап үлгісі
{
  "id": "uuid", "providerMode": "sandbox", "status": "active", "displayName": "Development"
}
GET/sandbox/payment-intents/{paymentIntentId}Sandbox payment intent алу

Шот не QR test күйі.

Авторизация: Bearer API keyPermission: history:readHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringИәSandbox қосылымының міндетті UUID-і.
paymentIntentIdpathuuidИәTole төлем ниетінің UUID-і.
Сұрау үлгісі
curl https://api.tolepay.kz/v1/sandbox/payment-intents/$PAYMENT_INTENT_ID \
  -H "Authorization: Bearer $TOLE_TEST_API_KEY" \
  -H "X-Tole-Connection-Id: $SANDBOX_CONNECTION_ID"
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "id": "uuid", "kind": "invoice", "status": "pending", "amount": 5000, "currency": "KZT", "environment": "sandbox" }
}
POST/sandbox/payment-intents/{paymentIntentId}/simulateТөлем нәтижесін модельдеу

Sandbox intent-ті terminal status-қа ауыстырып, webhook жасайды.

Авторизация: Bearer API keyPermission: sandbox:simulateHTTP: 200 OK
ӨрісОрныТүріМіндеттіСипаттама
X-Tole-Connection-IdheaderstringИәSandbox қосылымының міндетті UUID-і.
paymentIntentIdpathuuidИәTole төлем ниетінің UUID-і.
statusbodyenumИәpaid | cancelled | expired | failed
Сұрау үлгісі
curl https://api.tolepay.kz/v1/sandbox/payment-intents/$PAYMENT_INTENT_ID/simulate \
  -X POST \
  -H "Authorization: Bearer $TOLE_TEST_API_KEY" \
  -H "X-Tole-Connection-Id: $SANDBOX_CONNECTION_ID" \
  -H "Content-Type: application/json" \
  -d '{"status":"paid"}'
200 OK · Жауап үлгісі
{
  "ok": true,
  "data": { "id": "uuid", "kind": "invoice", "status": "paid", "environment": "sandbox" }
}

API кілттері және permissions

Кілт кабинетте немесе JWT арқылы management API-мен жасалады. Raw secret тек бір рет қайтарылады.

GET/api-keys

JWT · Список ключей; query cursor и limit 1–100

POST/api-keys

JWT · Создать: { name, grants: [{ connectionId, permissions }] }

PUT/api-keys/{apiKeyId}

JWT · Заменить name и grants; нужен expectedRevision

POST/api-keys/{apiKeyId}/revoke

JWT · Отозвать ключ; повторный revoke безопасен

PermissionРазрешает
invoice:createPOST /invoices
invoice:readclient-info, invoice history/details, invoice payment intent
invoice:cancelPOST /invoices/{id}/cancel
qr:createPOST /qr
qr:readQR details и QR payment intent
history:readhistory endpoints и sandbox payment intent
refund:createPOST /refunds
sandbox:simulatePOST /sandbox/payment-intents/{id}/simulate
POST /api-keys · request
{
  "name": "Production backend",
  "grants": [{
    "connectionId": "7a67d6bd-5daf-47af-b899-fdb8b7db4d63",
    "permissions": ["invoice:create", "invoice:read", "invoice:cancel"]
  }]
}
201 Created · secret returned once
{
  "apiKey": {
    "id": "uuid", "name": "Production backend", "keyPrefix": "tole_sk_live_v1.…", "status": "active",
    "revision": 1,
    "grants": [{
      "connectionId": "uuid", "connectionName": "main", "environment": "live",
      "permissions": ["invoice:create", "invoice:read", "invoice:cancel"]
    }]
  },
  "secret": "tole_sk_live_v1.<uuid>.<secret>"
}

Webhooks

Webhook endpoint JWT арқылы жасалады. URL HTTPS болуы тиіс. whsec_* құпиясы бір рет қайтарылады.

GET/webhook-endpoints

JWT · Список endpoint-ов

POST/webhook-endpoints

JWT · Создать: { name, url }; secret возвращается один раз

POST/webhook-endpoints/{endpointId}/disable

JWT · Отключить; body {}

GET/webhook-deliveries?status=…

JWT · pending | processing | delivered | dead_letter

POST/webhook-deliveries/{deliveryId}/replay

JWT · Повторить dead-letter delivery; body {}

HTTP delivery

webhook-id

UUID события

webhook-timestamp

Unix timestamp

webhook-signature

v1=<hex HMAC-SHA256>

Payment webhook event
{
  "id": "c2e94dd8-9802-44e7-a52b-14f45d5b9cdb",
  "type": "payment.paid",
  "createdAt": "2026-08-23T10:01:00.000Z",
  "data": { "providerStatus": "SandboxProcessed", "environment": "sandbox" }
}

Event types: payment.created, payment.paid, payment.cancelled, payment.expired, payment.failed, payment.partially_refunded, payment.refunded, refund.reserved, refund.succeeded, refund.rejected, refund.outcome_unknown, operation.succeeded, operation.rejected, operation.outcome_unknown.

В контракте v1 состав data зависит от типа события и не гарантирует paymentIntentId. Не придумывайте это поле в интеграции: webhook используйте как сигнал, а итоговое состояние сверяйте по сохранённым UUID через payment-intent endpoints.

Проверяйте подпись по exact raw body до JSON.parse. Сохраняйте event id и обрабатывайте событие идемпотентно. Возвращайте 2xx только после надёжной фиксации события.

Node.js · signature verification
import { createHmac, timingSafeEqual } from "node:crypto";

const signed = `${webhookId}.${timestamp}.${rawBody}`;
const expected = "v1=" + createHmac("sha256", secret)
  .update(signed, "utf8")
  .digest("hex");

const actualBytes = Buffer.from(signature, "utf8");
const expectedBytes = Buffer.from(expected, "utf8");
if (actualBytes.length !== expectedBytes.length ||
    !timingSafeEqual(actualBytes, expectedBytes)) {
  throw new Error("Invalid Tole webhook signature");
}

Billing management API

Тариф, usage және жазылым төлеміне арналған JWT endpoints.

GET/billing/overview

JWT · Subscription, usage, invoices и текущий checkout

GET/billing/plans

JWT · Доступные публичные планы и entitlements

GET/billing/invoices/{invoiceId}

JWT · Получить owner-scoped billing invoice

POST/billing/checkout

JWT · Создать или продолжить checkout: { planCode }

GET/billing/checkout/{checkoutId}

JWT · Получить статус checkout

POST/billing/subscription/cancel

JWT · Отменить подписку в конце периода

POST/billing/webhooks/kaspi

provider callback · Служебный HMAC callback; не вызывается merchant-интеграцией

POST /billing/checkout · request
{
  "planCode": "business"
}
201 Created · checkout
{
  "id": "uuid",
  "status": "pending",
  "planCode": "business",
  "planName": "Business",
  "amountKzt": 22500,
  "currency": "KZT",
  "paymentUrl": "https://…",
  "receiptUrl": null,
  "expiresAt": "2026-08-23T11:00:00.000Z",
  "paidAt": null,
  "createdAt": "2026-08-23T10:00:00.000Z"
}

Жауаптар, идемпотенттілік және polling

200 / 201

Complete

Сохраните data.id/paymentIntentId и commandId. Повтор с тем же Idempotency-Key вернёт тот же результат и header Idempotent-Replayed: true.

202 in_progress

Wait

Читайте Retry-After: 2 и Location. Poll GET /commands/:commandId. Не создавайте новую mutation.

202 outcome_unknown

Do not retry

Kaspi мог выполнить операцию. Проверяйте command и payment intent; новый create может дать дубль.

202 Accepted · in progress
{
  "ok": false, "kind": "in_progress", "commandId": "uuid", "replayed": true
}
202 Accepted · outcome unknown
{
  "ok": false, "kind": "outcome_unknown", "commandId": "uuid", "replayed": false
}

Payment intent statuses: pending, paid, cancelled, expired, failed, partially_refunded, refunded.

REST API қателері

Интеграцияда HTTP status және code қолданыңыз. message тек диагностика үшін.

Error response
{
  "statusCode": 409,
  "code": "PUBLIC_API_IDEMPOTENCY_CONFLICT",
  "message": "The Idempotency-Key was already used for a different request"
}
HTTPcodeЧто делать
400PUBLIC_API_VALIDATION_ERRORИсправить body, query, UUID или заголовок. Не повторять без изменения запроса.
401API_KEY_INVALID_CREDENTIALПроверить namespace и заменить неверный или отозванный ключ.
402BILLING_SUBSCRIPTION_UNAVAILABLE
BILLING_ENTITLEMENT_UNAVAILABLE
Активировать тариф или возможность.
403PUBLIC_API_FORBIDDENПроверить grant, permission и X-Tole-Connection-Id.
404PUBLIC_API_RESOURCE_NOT_FOUNDПроверить локальный UUID и environment; чужие ресурсы также выглядят как 404.
409PUBLIC_API_IDEMPOTENCY_CONFLICTНе менять body под старым ключом. Для новой операции создать новый key.
409PUBLIC_API_DEFAULT_CONNECTION_REQUIRED
PUBLIC_API_DEFAULT_CONNECTION_UNAVAILABLE
Передать connection header или исправить основное подключение.
409PAYMENT_INVALID_STATE
PAYMENT_REFUND_LIMIT_EXCEEDED
Перечитать payment intent и исправить переход или сумму.
429RATE_LIMIT_EXCEEDED
BILLING_LIMIT_EXCEEDED
Соблюдать Retry-After или лимит тарифа.
502PUBLIC_API_UPSTREAM_REJECTEDKaspi отклонил команду. Исправить бизнес-условия перед новой командой.
503PUBLIC_API_UNAVAILABLE
RATE_LIMIT_UNAVAILABLE
Для read — backoff. Для mutation сначала проверить commandId.
500PUBLIC_API_INTERNAL_ERRORСохранить безопасный context и обратиться в поддержку.
WhatsApp-қа жазу