/create
Этот эндпоинт создаёт новый инвойс для оплаты. Вы предоставляете сумму платежа и валюту в фиате (например, USD, EUR, RUB), а API возвращает pay_url, который вы должны отправить вашему клиенту для завершения платежа.
Эндпоинт также позволяет необязательную настройку UI через объект ui и поддерживает указание URL вебхука для получения обновлений статуса платежа. Все обязательные поля проходят валидацию, и API гарантирует, что инвойс готов к немедленному использованию после создания.
Чтобы проверить, был ли оплачен инвойс, вы можете:
- Отправить запрос к эндпоинту
/infoдля получения текущего статуса инвойса, или - Указать URL вебхука при создании инвойса и ожидать, пока API автоматически отправит обновление статуса платежа.
HTTP Запрос
Заголовок раздела «HTTP Запрос»- Метод:
POST - URL:
https://api.cru.cash/v1/invoice/create - Заголовки:
Authorization: Bearer YOUR_API_KEY_HERE
Поля запроса
Заголовок раздела «Поля запроса»| Поле | Название в JSON | Тип | Обязательно | Описание / Валидация |
|---|---|---|---|---|
| Время жизни * | lifetime | int | да | Время жизни в минутах. Минимум 3, максимум 1440. |
| Сумма * | amount | string | да | Сумма платежа в фиатной валюте. Минимум: 100 RUB, 1 USD, 1 EUR. Максимум: 10,000,000. |
| Валюта * | currency | string | да | Валюта, в которой указана amount. Допустимые значения: RUB, USD, EUR. |
| Полезная нагрузка | payload | string | нет | Метаданные, предоставленные мерчантом. Необязательно. Длина: 5–16384 символа. |
| Вебхук | webhook | string | нет | URL вебхука для уведомлений. Необязательно. Должен использовать HTTPS. Длина: 10–2048 символов. |
| Описание | ui.description | string | нет | Описание платежа. Необязательно. Минимум 3, максимум 256 символов. Допустимые символы: латинские буквы, кириллица, цифры, пробел, #. |
| Ссылка для редиректа | ui.redirect_url | string | нет | URL для редиректа после оплаты. Необязательно. Должен использовать HTTP или HTTPS. Длина: 10–2048 символов. |
Поля ответа
Заголовок раздела «Поля ответа»| Поле | Название в JSON | Тип | Описание |
|---|---|---|---|
| ID инвойса | invoice.id | string | Уникальный ID созданного инвойса. |
| Время истечения | invoice.expires_at | int | Unix временная метка, когда истекает срок действия инвойса. |
| URL платежа | pay_url | string | URL для отправки клиенту для завершения платежа. |
| Тестовый режим | test_mode | boolean | Указывает, был ли инвойс создан в тестовом режиме. |
Примеры тела запроса и ответов
Заголовок раздела «Примеры тела запроса и ответов»| Заголовок | Значение | Описание |
|---|---|---|
| Authorization | Bearer YOUR_API_KEY_HERE | Ваш API ключ для аутентификации |
Создаёт новый инвойс со временем жизни 30 минут и суммой платежа 100 USD. После завершения платежа уведомление вебхука будет отправлено на https://test-webhook.com
Запрос #1
Заголовок раздела «Запрос #1»{"lifetime": 30,"amount": "100","webhook": "https://test-webhook.com","currency": "USD","payload": "{\"product\":\"vpn_pro\",\"period\":30,\"user_id\":\"u_987654\",\"note\":\"Инвойс для месячной подписки VPN\"}""ui": { "description": "Оплата заказа #9876", "redirect_url": "https://t.me/crucashbot" }}Ответ #1
Заголовок раздела «Ответ #1»{"invoice": { "id": "f2b19206-2003-4b16-b254-4418a07bac47", "expires_at": 1768572610},"pay_url": "http://pay.cru.cash/invoice/f2b19206-2003-4b16-b254-4418a07bac47","test_mode": false}Создаёт новый инвойс со временем жизни 5 минут и суммой платежа 2300 RUB.
Запрос #2
Заголовок раздела «Запрос #2»{"lifetime": 5,"amount": "2300","currency": "RUB"}Ответ #2
Заголовок раздела «Ответ #2»{"invoice": { "id": "0afd1195-52c5-48e5-a401-a52c5953d3c8", "expires_at": 1768572913},"pay_url": "http://pay.cru.cash/invoice/0afd1195-52c5-48e5-a401-a52c5953d3c8","test_mode": false}