Методы API
Создать инвойс
POST
/api/v1/invoicesНужный scope: invoices:write| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
amount | string | да | Сумма инвойса, больше 0, до 6 знаков после точки |
currency | string | нет | USDT (по умолчанию), USDC или USD. USD оплачивается в USDT 1:1 |
network | string | нет | tron, ton, solana, sim. Без сети плательщик выберет её на странице оплаты |
description | string | нет | До 1024 символов, показывается плательщику |
external_id | string | нет | Ваш идентификатор того, за что этот инвойс: номер заказа, id пользователя, id пополнения. 1–64 символа: латинские буквы, цифры и _ - . :. Возвращается в ответах и вебхуках, по нему можно найти инвойсы: GET /invoices?external_id=… |
payload | string | нет | До 4 КБ произвольного текста (например, JSON). Возвращается в ответах и вебхуках как есть |
expires_in | int | нет | Срок жизни в секундах, 300–86400, по умолчанию 3600 |
fee_payer | string | нет | Кто платит комиссию шлюза: merchant, payer, split. По умолчанию из настроек приложения |
return_url | string | нет | Куда вернуть плательщика после оплаты. По умолчанию из настроек приложения |
- Без
networkв ответе"network": nullи"address": null. Адрес выделяется, когда плательщик выберет сеть наpay_url. - Инвойс получает адрес из пула. Пока инвойс открыт, адрес закреплён только за ним. После закрытия инвойса адрес через паузу (по умолчанию 1 час) выдаётся другому инвойсу, возможно другого мерчанта. Не сохраняйте адрес как постоянные реквизиты плательщика и не давайте платить по адресу старого инвойса: см. правило 11 в разделе о статусах. Отправьте плательщика на
pay_urlили покажитеaddressиpay_amountна своей странице. assetэто монета, в которой платят. Приcurrency: "USD"этоUSDT.- На один
external_idв приложении бывает один живой инвойс. Пока инвойс с этимexternal_idоткрыт (active,paying,partially_paid) или оплачен (paid,overpaid), второй создать нельзя: ошибка 409EXTERNAL_ID_TAKEN. Когда инвойс истёк или отменён, на тот жеexternal_idможно выставить новый. Чтобы узнать, оплачен ли заказ, запроситеGET /invoices?external_id=order-5512&status=paid,overpaid.
Комиссия шлюза и pay_amount. Комиссия fee = max(1 % от amount, 0.1), округление до 6 знаков.
fee_payer | pay_amount (платит плательщик) | Мерчант получает | Пример, amount = 100 |
|---|---|---|---|
merchant | amount | amount − fee | платит 100, мерчант получает 99 |
payer | amount + fee | amount | платит 101, мерчант получает 100 |
split | amount + fee/2 | amount − fee/2 | платит 100.5, мерчант получает 99.5 |