Создание выплаты

Схема взаимодействия

1. Ваш сервер делает запрос на создание заявки и получает идентификатор сделки.

2. Система обрабатывает перевод пользователю на указанные реквизиты и отправляет вебхук-уведомление на ваш сервер об успешной или неуспешной оплате.

Интеграция backend

API предназначен для интеграции вашего бэкэнда с системой для обработки выплат на реквизиты пользователей. Вы можете создать заявку на выплату, указав сумму, реквизиты, ID кассы и ссылку на ваш вебхук для получения уведомлений о статусе сделки.

API поддерживает различные типы реквизитов, включая банковские карты и номера телефонов для переводов через Систему быстрых платежей (СБП).

Request

POST https://repay.cx/payout_api/v1/external/payout_deals/

Headers

Name	Type	Description
api-key	string	API-ключ вашей кассы

Body

Name	Type	Description	Required
amount	string (number)	Сумма для перевода
bank_id	string	ID банка, соответствующего реквизитам
option_id	string	ID банка, если перевод осуществляется по СБП
requisites	string	Номер карты, телефон или реквизиты получателя
requisites_type	string	Тип реквизита: card_number для карт phone_number для СБП account_number для переводов по номеру счета
webhook_url	string	Адрес для получения вебхука с результатом обработки сделки
order_id	string	Ваш внутренний номер заявки
payload	object	Дополнительная информация для идентификации пользователя, включая user_id
payload.user_id	string	Уникальный идентификатор клиента на вашей стороне

Пример на cURL

curl -X POST https://repay.cx/payout_api/v1/external/payout_deals/ \
  -H "api-key: cashier_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1000,
    "bank_id": "bd02ced3-36a5-4aad-b0af-bf1f86065a79",
    "requisites": "2202098765432109",
    "requisites_type": "card_number",
    "webhook_url": "https://domain.com/webhook",
    "order_id": "0001",
    "payload": {
        "user_id": "bd01ced4-36a4-4aad-b0af-bf1f86095a79"
    }
  }'

Response

Пример успешного ответа

{
    "status_code": 200,
    "error": {},
    "payload": {
        "id": "3fac9f77-776a-4567-b5b5-fc75f5349889",
        "state": "created",
        "bank_id": "bd02ced3-36a5-4aad-b0af-bf1f86065a79",
        "bank_name": null,
        "bank_title": null,
        "merchant_title": null,
        "option_id": null,
        "option_name": null,
        "option_title": null,
        "requisites_num": "2202201374695646",
        "requisites_type": "card_number",
        "amount": "1000.000",
        "commission": "1.0196",
        "commission_sign": "₮",
        "amount_usdt": "11.2161",
        "webhook_url": "https://google.com/webhook",
        "currency_sign": null,
        "currency_name": null,
        "payload": {},
        "order_id": "ee772cd7-64e6-42e1-bd6f-b213d5e06872",
        "created_at": "2024-10-04T12:42:03.310889+00:00",
        "external_order_id": null,
        "merchant_id": null,
        "user_id": null,
        "cheques": []
    }
}

Name	Type	Description
payload	object	Основная полезная нагрузка ответа, содержащая данные о транзакции
payload.id	string	Уникальный идентификатор созданной заявки
payload.state	string	Статус сделки, например, created
payload.bank_id	string	ID банка, связанного с реквизитами
payload.requisites	string	Номер карты или реквизитов
payload.requisites_type	string	Тип реквизитa: card_number phone_number
payload.amount	string (number)	Сумма перевода
payload.comission	string	Сумма комиссии
payload.comission_sign	string	Тезер сделки мерчанта
payload.amount_usdt	string (number)	Сумма сделки в USDT
payload.webhook_url	string	URL для отправки вебхука, уведомляющего о статусе транзакции
payload.order_id	string	ID, который вы передавали при создании сделки
payload.created_at	string	Время создания заявки

Примеры неудачного ответа

1. Если номер карты не соответствует банку метода:

   {
     "detail": "Invalid card number"
   }

2. Если недостаточно баланса кассы для выполнения выплаты:

   {
     "detail": "Not enough money"
   }

3. Если номер карты не верный, вы получите ответ

   {
     "detail": "Invalid requisites"
   }

Возможные ошибки:

Code	Name	Description
400	Bad request	Некорректный запрос