Получение информации о заказе

Запрос

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

WARNING

API ключ сотрудника мерчанта не подходит для данных целей.

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

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

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

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

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

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

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

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

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

Имя	Тип	Описание
invoice_id	string format: uuid	ID операции в нашей системе
order_id	string min: 1 max: 100	ID платежа в вашей системе
merchant_id	string format: uuid	Идентификатор мерчанта
status	string enum: [wait, success, hold, expired, refund]	Статус заказа. Варианты: wait - Ожидается success - Оплачен hold - Оплачен, средства заморожены expired - Истек refund - Возврат
amount	number format: double	Сумма платежа
currency	string enum: [RUB, UAH, USD, EUR]	Валюта платежа
credited	number format: double nullable: true	Сумма к зачислению на баланс. В случае возрата, это сумма которая списана с баланса nullable если заказ не оплачен (status: success, hold) либо не было возврата (status: refund)
merchant_commission_amount	number format: double nullable: true	Сумма комиссии мерчанта. nullable если не указан метод оплаты
user_commission_amount	number format: double nullable: true	Сумма комиссии клиента. nullable если не указан метод оплаты
service	string nullable: true	Метод оплаты
custom_fields	object examples: - {} - {"my_var": "5395"}	Дополнительные параметры пользователя
created_at	string format: datetime [Y-m-d H:i:s]	Дата создания заказа в UTC+0
expired_at	string format: datetime [Y-m-d H:i:s]	Дата закрытия заказа в UTC+0
paid_at	string format: datetime [Y-m-d H:i:s] nullable: true	Дата оплаты заказа в UTC+0. nullable если заказ не оплачен (status: success, hold)
refund_at	string format: datetime [Y-m-d H:i:s] nullable: true	Дата возврата заказа в UTC+0. nullable если не выполнялся возврат после оплаты (status: refund)

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

Успех

{
    "invoice_id": "5eff96c0-ed55-43b7-ba98-5c2364d79a94",
    "order_id": "my_order_id_1",
    "merchant_id": "48ceb004-06b1-4ed6-9b61-aa8ad0dc5ae0",
    "status": "expired",
    "amount": 750,
    "currency": "RUB",
    "credited": null,
    "merchant_commission_amount": 142.2,
    "user_commission_amount": 41.8,
    "service": "trx",
    "custom_fields": {
        "id": "59049284"
    },
    "created_at": "2025-09-01 23:59:30",
    "expired_at": "2025-09-02 00:19:54",
    "paid_at": null,
	"refund_at": null
}

Ошибка

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

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

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