Создание счёта
Создаёт счёт на оплату в выбранной монете и сети.
POST/invoices
Системная информация
- API-ключ
- Требуется
- Rate Limit
- 20 запросов в минуту
Body-параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| coinCode | string | Да | Код криптовалюты, например USDT. |
| networkCode | string | Да | Код блокчейн-сети, например tron. |
| amount | string | Да | Фиатная сумма платежа. Максимум 2 знака после точки. |
| currency | string | Нет | Фиатная валюта суммы: USD, EUR, RUB. По умолчанию USD. |
| orderId | string | Нет | Ваш ID заказа. Используется для идемпотентности в рамках проекта. |
| description | string | Нет | Описание платежа. |
Описание полей ответа
| Параметр | Тип | Описание |
|---|---|---|
| uuid | string | UUID счёта. |
| projectUuid | string | UUID проекта. |
| coinCode | string | Код криптовалюты. |
| networkCode | string | Код блокчейн-сети. |
| coinName | string | Название криптовалюты. |
| networkName | string | Название сети. |
| networkPrefix | string | Стандарт токена в сети, например TRC-20. |
| amount | string | Сумма к оплате в криптовалюте. |
| sourceAmount | string | Сумма счёта в исходной валюте. |
| sourceCurrency | string | Исходная валюта счёта. |
| sourceRate | string | Курс пересчёта исходной валюты в криптовалюту. |
| status | string | Статус счёта, см. «Статусы». |
| confirmedAmount | string | Оплаченная и подтверждённая сумма. |
| unconfirmedAmount | string | Поступившая, но ещё не подтверждённая сумма. |
| remainingAmount | string | Сколько осталось оплатить. |
| overpaidAmount | string | Сумма переплаты. |
Идемпотентность
| Ситуация | Результат |
|---|---|
Тот же orderId и тот же payload | Возвращается существующий счёт. |
Тот же orderId, другой payload | 409 INVOICE_EXTERNAL_ID_CONFLICT |
Без orderId | Каждый POST создаёт новый счёт. |
429 INVOICE_CREATION_RATE_LIMITED | Лимит: 20 счетов за 60 секунд на проект. |
500 или таймаут | Исход неизвестен: повторяйте только с тем же orderId и сохраните requestId. |
Возможные ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | INVOICE_COIN_UNAVAILABLE | Выбранная монета недоступна для счёта. |
| 400 | INVOICE_AMOUNT_INVALID | Некорректная сумма счёта. |
| 400 | INVOICE_AMOUNT_BELOW_MINIMUM | Сумма ниже минимально допустимой. |
| 400 | INVOICE_AMOUNT_ABOVE_MAXIMUM | Сумма превышает максимально допустимую. |
| 400 | INVOICE_DESCRIPTION_INVALID | Некорректное описание счёта. |
| 400 | INVOICE_RATE_UNAVAILABLE | Недоступен курс выбранной монеты. |
| 400 | INVOICE_ADDRESS_GENERATION_FAILED | Не удалось сгенерировать адрес счёта. |
| 400 | VALIDATION_FAILED | Ошибка проверки параметров запроса. |
| 409 | INVOICE_EXTERNAL_ID_CONFLICT | orderId уже используется с другими параметрами счёта. |
| 429 | INVOICE_CREATION_RATE_LIMITED | Превышен лимит создания счетов. |