Информация об API

Merchant API -- REST API для интеграции платежного шлюза Arcanum Pay в ваш продукт. API позволяет принимать платежи, проводить выводы средств, оформлять возвраты и получать информацию о балансах.

Базовый URL

https://api.arcanumpay.ru/api/v1

Формат ответа

Все ответы возвращаются в формате JSON. Успешный ответ содержит объект data:

{
  "data": {
    "operationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": 3,
    "amount": "100.00",
    "currency": "RUB"
  }
}

Обработка ошибок

В случае ошибки API возвращает соответствующий HTTP-код и объект с описанием:

{
  "statusCode": 403,
  "message": "Forbidden",
  "error": "Merchant KYB verification is not completed."
}

HTTP-коды ошибок

Код	Описание
400	Невалидные параметры запроса
401	Отсутствует или невалидный заголовок аутентификации
403	Доступ запрещен (KYB, контракт, права)
404	Ресурс не найден
422	Маршрут не найден / недостаточно средств

Коды ошибок операций

Код	Описание
AntifraudBlocked	Операция заблокирована антифрод-системой
MethodConfigValidation	Платежный метод не настроен
PaymentMethodValidation	Невалидный платежный метод / реквизиты
GeneralDecline	Общий отказ провайдера
NoRouteFound	Не найден маршрут обработки
InsufficientBalance	Недостаточно средств на балансе

Объект userData

Многие методы принимают необязательный объект userData с информацией о пользователе. Эти данные используются для антифрод-проверок и могут быть обязательными для некоторых платежных методов.

Поле	Тип	Описание
email	string	Email пользователя
phone	string	Телефон (например, +1234567890)
ipAddress	string	IP-адрес пользователя
firstName	string	Имя
lastName	string	Фамилия
country	string	Код страны (ISO 3166-1 alpha-2)
city	string	Город
address	string	Адрес
state	string	Штат / регион
zipCode	string	Почтовый индекс
dateOfBirth	string	Дата рождения (например, 1990-01-15)
deviceType	string	Тип устройства (WEB_DESKTOP, MOBILE_APP и др.)

Методы API

Метод	Эндпоинт	Описание
POST	/deposits	Создание платежа
GET	/deposits/:id/status	Статус платежа
POST	/withdrawals	Создание выплаты
GET	/withdrawals/:id/status	Статус выплаты
POST	/refunds	Создание возврата
GET	/refunds/:id/status	Статус возврата
GET	/balances	Балансы мерчанта