Создание заказа
Запрос
Необходим API Ключ с доступом к созданию заказа.
WARNING
API ключ сотрудника мерчанта не подходит для данных целей.
URL: https://api.fride.io/invoices/create
Метод отправки: POST
Заголовки запроса
bash
Accept: application/json
Content-Type: application/json
X-Api-Key: {api_key}Параметры запроса
| Имя поля | Тип поля | Описание |
|---|---|---|
| merchant_id | string format: uuid required | Идентификатор мерчанта (находится в настройках мерчанта) |
| order_id | string min: 1 max: 100 required | ID платежа в вашей системе Значение может содержать буквы (включая русские), цифры и специальные символы _-+[]|=*@, длиной от 1 до 100 символов |
| amount | number format: double required | Сумма к оплате. (Если в сумме есть копейки, то отправляйте их с разделителем ".") Пример: 10.28 |
| currency | string enum: [RUB, UAH, USD, EUR] required | Валюта платежа |
| comment | string min: 1 max: 512 | Назначение платежа (показывается клиенту при оплате) |
| expire | int | Время жизни заказа в минутах. Минимум 60 минут, максимум - 5 дней / 7200 минут (По умолчанию - 6 часов) |
| custom_fields | object examples: - {"my_var1": "4", "my_var2": "54215", "my_var3": "535355"} - {"my_var": "5395"} | Дополнительные параметры пользователя Требования к объекту: - Максимум 5 элементов (пар ключ-значение) - Ключ должен содержать только латинские буквы, цифры и специальные символы _, длиной от 1 до 15 символов- Значение может содержать буквы (включая русские), цифры и специальные символы _-+[]|=*@, длиной от 1 до 165 символов |
| service | string | Код метода оплаты для автоматического клика на него |
| string format: email | Почта покупателя для автоматического заполнения | |
| telegram_id_client | int | Telegram ID покупателя Поле обязательно если ваш мерчант связан с Telegram ботами, так-же если эндпоинт выдает ошибку о необходимости заполнить данное поле |
Ответ после запроса
Формат ответа: JSON
Схема успешного ответа:
| Имя | Тип | Описание |
|---|---|---|
| id | string format: uuid | ID операции в нашей системе |
| amount | number format: double | Сумма платежа |
| currency | string enum: [RUB, UAH, USD, EUR] | Валюта платежа |
| url | string format: uri | Ссылка на форму оплаты |
| expired_at | string format: datetime [Y-m-d H:i:s] | Дата закрытия заказа в UTC+0 |
| is_created | boolean | Создан заказ, или он уже существует: true - создан false - существует |
Примеры ответа:
json
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"amount": 0,
"currency": "USD",
"url": "https://...",
"expired_at": "2025-07-13 21:01:24",
"is_created": true
}json
{"error": "Не передан заголовок X-Api-Key"}Возможные статусы ответа:
- 200: Успех
- 400: Ошибка валидации
- 401: Ошибка авторизации
- 403: Ошибка доступа
- 404: Ошибка поиска
- 429: Ограничение запросов
- 500: Внутренняя ошибка системы
