Начало работы

Что нужно для первого запроса к API и что API умеет сегодня.

Paydex принимает платежи мерчанта и ведёт их к платёжным провайдерам. С API работает сервер мерчанта. Документация описывает только то, что выпущено.

Что нужно знать сразу

  • Адрес API один для тестового и боевого контура: https://api.paydex.co.uk. Все ручки начинаются с /api/v1. Только HTTPS.
  • API вызывается с сервера. Заголовков CORS нет намеренно: ключ API не должен попадать в код страницы или приложения.
  • Запросы и ответы в JSON, кодировка UTF-8.
  • Каждый запрос несёт ключ API. Ключ определяет мерчанта и контур.
  • Суммы это целые числа минорных единиц валюты, записанные строкой.
  • У каждого ответа есть номер запроса для обращения в поддержку.

Первый запрос

  1. Получите тестовый ключ у администратора Paydex. Как устроен ключ и где его выдают: Авторизация.
  2. Положите ключ в переменную окружения на своём сервере. В командах документации ключ берётся оттуда.

    export PAYDEX_API_KEY='ключ, который вам выдали'
  3. Проверьте ключ:

    curl -sS https://api.paydex.co.uk/api/v1/me \
      -H "Authorization: Bearer $PAYDEX_API_KEY"

    В ответ придут мерчант, контур и открытая часть ключа: поля и пример ответа. Если пришёл отказ, его причина названа в теле: Формат ошибок.

Что API умеет сегодня

МетодАдресЧто делает
GET/api/v1/meПроверить ключ
GET/api/v1/servicesСписок сервисов
POST/api/v1/paymentsСоздать платёж
GET/api/v1/paymentsНайти платёж по номеру заказа
GET/api/v1/payments/:idПрочитать платёж
POST/api/v1/payments/:id/refundsСоздать возврат
GET/api/v1/payments/:id/refundsВозвраты платежа
GET/api/v1/payments/:id/refunds/:refundIdПрочитать возврат
POST/api/v1/payoutsЗавести выплату
GET/api/v1/payouts/:idПрочитать выплату
POST/api/v1/payouts/:id/cancelОтменить выплату
POST/api/v1/notifications/secretВыпустить секрет подписи уведомлений

Платёж создаётся одним запросом, плательщик платит на странице оплаты или в вашей форме, исход приходит уведомлением или узнаётся чтением. Успешный платёж можно вернуть. Порядок работы: Приём платежа. Боевой приём закрыт, платежи принимает тестовый контур. Ручка появляется в справочнике и в журнале изменений в день выпуска, не раньше.

API v1 · собрано 18.11.2026 · выпуск f13e6bf

Справочник методов собирается из кода сервера: он не описывает адрес, которого нет.