Получение информации о выплате

Запрос

Необходим API Ключ с доступом к информации о выплатах.

URL: https://api.fride.io/payoff/getInfo
Метод отправки: GET

Заголовки запроса

Accept: application/json
X-Api-Key: {api_key}

Query параметры запроса

Имя поля	Тип поля	Описание
payoff_id *	string format: uuid	ID выплаты в нашей системе
order_id *	string min: 1 max: 100	ID платежа в вашей системе Значение может содержать буквы (включая русские), цифры и специальные символы _-+[]|=*@, длиной от 1 до 100 символов

* Поля обязательные в случае отсутствия другого такого же поля

Ответ после запроса

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

Схема успешного ответа:

Имя	Тип	Описание
payoff_id	string format: uuid	ID выплаты
order_id	string nullable: true	ID платежа в вашей системе
service	string	Метод выплаты
payoff_data	object example: {}	Дополнительные данные выплаты (для СБП и Мобильной связи РФ)
payoff_data.sbp_bank_label	string	Название банка СБП (обязательно для СБП)
payoff_data.mobile_ru_operator_label	string	Название мобильного оператора РФ (обязательно для Мобильной связи РФ)
wallet	string	Номер карты/телефона/кошелька для выплаты
status	string enum: [success, fail]	Статус выплаты Варианты: success - Выполнена fail - Отклонена
amount	number format: double	Сумма к выплате в рублях
commission	number format: double	Комиссия в рублях
currency	string	Валюта платежа
amount_in_currency	number format: float	Сумма к выплате в указаной валюте платежа
amount_rate	number format: double	Курс конвертации рублей в валюту платежа. Параметр передается если валюта платежа не RUB
error_message	string nullable: true	Причина отклонения выплаты. Параметр передается если статус выплаты Отклонена
created_at	string format: datetime [Y-m-d H:i:s]	Дата создания выплаты UTC+0
complete_at	string format: datetime [Y-m-d H:i:s]	Дата выполнения либо отклонения выплаты UTC+0

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

Успех

{
    "payoff_id": "24f48f28-4b02-42c7-ad0e-ab14ec7a7d05",
    "order_id": null,
    "service": "mobile.ru",
    "payoff_data": {
        "mobile_ru_operator_label": "Мегафон"
    },
    "wallet": "******",
    "status": "success",
    "amount": 1000,
    "commission": 50,
    "currency": "RUB",
    "amount_in_currency": 1000,
    "created_at": "2025-08-10 08:46:30",
    "complete_at": "2025-08-10 11:48:25"
}

Ошибка

{"error": "Не передан заголовок X-Api-Key"}

Возможные статусы ответа:

• 200: Успех
• 400: Ошибка валидации
• 401: Ошибка авторизации
• 403: Ошибка доступа
• 404: Ошибка поиска
• 429: Ограничение запросов
• 500: Внутренняя ошибка системы