Demo Payments API

Приём платежей картами, Kaspi и Apple Pay через единый REST API. Эта документация — пример того, как выглядит проект на OkDoc: страницы в Markdown, справочник из OpenAPI и живая песочница.

Как устроен API#

Базовый URL: https://api.example.kz/v1
Формат: JSON, кодировка UTF-8
Суммы передаются в минимальных единицах валюты (тиыны)
Все запросы требуют заголовок Authorization: Bearer <secret_key>

Информация

В песочнице справа на страницах API запросы уходят на httpbin.org — он возвращает то, что вы отправили. Так можно проверить формат запроса без реального ключа.

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

Статус	Описание
`pending`	Создан, ожидает оплаты
`paid`	Успешно оплачен
`failed`	Отклонён банком
`expired`	Истёк срок оплаты (15 минут)
`refunded`	Возвращён полностью или частично

Ошибки#

Ошибки возвращаются с HTTP-кодом 4xx/5xx и телом:

json

{
  "code": "validation_error",
  "message": "Поле amount должно быть больше 0",
  "details": [{ "field": "amount", "issue": "min" }]
}

Внимание

Никогда не передавайте секретный ключ в браузер. Используйте его только на сервере.