Информация о выплате

Для получения данных о конкретной PayOut заявке используется GET-запрос, включающий уникальный идентификатор заявки. Данный запрос возвращает информацию о статусе заявки, её сумме, реквизитах получателя и других параметрах. Авторизация выполняется с использованием API-ключа вашей кассы.

В этом разделе описывается процесс запроса информации по PayOut заявке через API. Вы можете получить детализированную информацию о каждой заявке, включая её статус, сумму и реквизиты получателя. Для выполнения запроса необходимо передать идентификатор заявки и авторизоваться с помощью API-ключа кассы.

Request

GET https://repay.cx/payout_api/v1/external/payout_deals/{merchant_deal_id}

Parameters

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

Headers

Name	Type	Description
merchant_deal_id	string	Уникальный идентификатор заявки (Merchant deal ID)

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

curl -X GET 'https://repay.cx/payout_api/v1/external/payout_deals/{merchant_deal_id}' \
-H 'api-key: ваш_api_ключ'

Response

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

Если запрос выполнен успешно, вы получите статус 200 OK и информацию о заявке.

{
    "status_code": 200,
    "id": "20f8286a-b181-4bb0-9e3b-f87ca4926dc9",
    "order_id": "0001",
    "amount": "1000",
    "recipient_type": "card_number",
    "recipient": "2202********3722",
    "state": "completed",
    "created_at": "2024-09-25T12:00:00Z",
    "updated_at": "2024-09-25T13:00:00Z"
}

Name	Type	Description
status_code	string (number)	Код статуса запроса (например, 200 для успешного запроса)
id	string	Уникальный идентификатор заявки в системе (System deal ID)
order_id	string	Уникальный идентификатор заявки на стороне мерчанта (Merchant deal ID)
amount	string (number)	Сумма заявки в фиатной валюте
recipient_type	string	Тип реквизитов получателя (например, card_number)
recipient	string	Реквизиты получателя (в случае перевода с карты на карту отображаются только первые 6 и последние 4 цифры карты)
state	string	Текущий статус заявки (например, completed, processing)
created_at	string	Время создания заявки
updated_at	string	Время последнего изменения заявки (например, момент завершения транзакции)

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

Если запрос выполнен некорректно, вы получите ответ с кодом ошибки и пояснением.

{
  "status_code": 400,
  "error": "Invalid merchant_deal_id"
}

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

Code	Name	Description
400	Bad Request	Неверный запрос (например, некорректный идентификатор заявки)
401	Unauthorized	Ошибка авторизации, неверный API-ключ
404	Not Found	Заявка с указанным идентификатором не найдена
500	Server Error	Внутренняя ошибка сервера