Массовые выплаты — общая информация

POST /withdrawals

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

Заголовки

Заголовок	Обязательный	Описание
merchant-id	Да	Идентификатор мерчанта
x-signature	Да	HMAC-SHA256 подпись запроса
Content-Type	Да	application/json

Важно: для подписи запросов на выплату используется отдельный секретный ключ (withdrawal secret), отличный от ключа для депозитов.

Тело запроса

Поле	Тип	Обязательный	Описание
amount	string	Да	Сумма выплаты (например, "500.00")
currency	string	Да	Валюта (RUB, и др.)
paymentMethod	string	Да	Платёжный метод (например, card)
userId	string	Да	Идентификатор пользователя мерчанта
merchantOperationId	string	Нет	Идентификатор операции на стороне мерчанта
callbackUrl	string	Нет	URL для отправки колбэков
requisites	object	Да	Реквизиты получателя
userData	UserData	Нет	Данные пользователя

Пример запроса

curl -X POST https://api.arcanumpay.ru/api/v1/withdrawals \
  -H "Content-Type: application/json" \
  -H "merchant-id: 12345" \
  -H "x-signature: a1b2c3d4e5f6..." \
  -d '{
    "amount": "500.00",
    "currency": "RUB",
    "paymentMethod": "card",
    "userId": "user-123",
    "merchantOperationId": "merch-op-002",
    "callbackUrl": "https://example.com/callback",
    "requisites": {
      "pan": "2202111111111111",
      "cardholderName": "Ivan Ivanov"
    }
  }'

Ответ

Поле	Тип	Описание
operationId	string	UUID созданной выплаты
status	number	Статус: 1 (Approved), 2 (Declined), 3 (Processing)
amount	string	Сумма операции
currency	string	Валюта
errorCode	string	Код ошибки (при отклонении)
errorMessage	string	Описание ошибки (при отклонении)

Пример ответа

{
  "data": {
    "operationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "status": 3,
    "amount": "500.00",
    "currency": "RUB"
  }
}

Ошибки

HTTP-код	Ошибка	Описание
403	Forbidden	Нет доступа к платёжному методу
422	NoRouteFound	Не найден маршрут обработки
422	InsufficientBalance	Недостаточно средств на балансе