API Документация

REST API для интеграции приёма платежей через СБП и банковские карты.

Аутентификация

Передавайте API-ключ в заголовке запроса. Ключи создаются в личном кабинете.

Authorization: Bearer pk_your_api_key
// или
X-API-Key: pk_your_api_key

Для POST-запросов рекомендуется подпись: X-Signature: HMAC-SHA256(body, secret)

Webhooks

При смене статуса платежа отправляется POST на webhook URL проекта.

{
  "event": "payment.success",
  "data": {
    "id": "clx...",
    "external_id": "order-123",
    "amount": 1500,
    "status": "SUCCESS",
    "method": "SBP",
    "paid_at": "2026-09-01T12:00:00Z"
  },
  "timestamp": "2026-09-01T12:00:00Z"
}

Проверяйте подпись в заголовке X-PayDock-Signature

Эндпоинты

POST/api/v1/payments

Создать платёж

Создаёт новый платёж и возвращает ссылку для оплаты.

Запрос:

{
  "amount": 1500,
  "method": "SBP",
  "description": "Заказ #123",
  "external_id": "order-123",
  "customer_email": "buyer@example.com",
  "return_url": "https://shop.ru/success",
  "fail_url": "https://shop.ru/fail"
}

Ответ:

{
  "id": "clx...",
  "amount": 1500,
  "status": "PENDING",
  "payment_url": "https://paydock.ru/pay/clx..."
}
GET/api/v1/payments/:id

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

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

Ответ:

{
  "id": "clx...",
  "status": "SUCCESS",
  "paid_at": "2026-09-01T12:00:00Z",
  "receipt": { "status": "SUCCESS", "fiscal_number": "12345" }
}
POST/api/v1/payments/:id/refund

Возврат платежа

Полный или частичный возврат успешного платежа.

Запрос:

{ "amount": 500 }

Ответ:

{
  "id": "clx...",
  "status": "REFUNDED",
  "refunded_amount": 1500,
  "amount": 1500
}
GET/api/v1/payments

Список платежей

Возвращает список платежей мерчанта. Параметры: limit, offset.

Коды статусов

СтатусОписание
PENDINGОжидает оплаты
PROCESSINGВ обработке
SUCCESSУспешно оплачен
FAILEDОшибка оплаты
CANCELLEDОтменён
REFUNDEDВозврат