Создание инвойса

Суть метода: при создании инвойса вы получаете ссылку и передаете ее вашему клиенту, далее ваш клиент при переходе по ссылке видит перечень доступных методов для оплаты, и использует тот, который ему больше нравится

Метод запроса

POST

Урл запроса

/api/v2/invoices

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

На вход принимаются следующие параметры

Название
Обяз.
Формат
Описание

order_id

string(1-200)

Ваш уникальный номер заявки

amount

string(1-255)

Сумма заявки

currency

string(1-255)

Валюта заявки. По умолчанию дефолтная валюта системы

payment_methods

массив строк

Список платежных методов, которые должны быть включены в инвойс. Применяется для усечения, поскольку по умолчанию включены все доступные. Доступные варианты - h2h, card, sbp, sbp-a

site_account

string(1-255)

Код счета на который будет выполняться зачисление, например sber

comment

string(1-255)

Примечание по операции

notification_url

string(1-255)

Ссылка для отправки уведомления по этой транзакции

success_url

string(1-1024)

Ссылка для перенаправления вашего клиента в случае успешной оплаты

fail_url

string(1-1024)

Ссылка для перенаправления вашего клиента в случае проблем с оплатой

ext_****

Детали по этим параметрам указаны в создании заявки

Пример запроса

curl --request POST \
  --url https://{{your_api_domain}}/api/v2/invoices \
  --header 'Authorization: Bearer {{your_api_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "order_id": "IN_2024_1289",
  "amount": "100.00"
}'

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

Название
Формат
Описание

id

number

Номер заявки в нашей системе

amount

string(1-255)

Сумма по заявке

commission

string(1-200)

Комиссия по заявке

payment_url

string(1-255)

Ссылка на оплату

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

{
  "id": 20,
  "amount": "100.00"
  "commission": "2.00",
  "payment_url": "https://some-domain.com/url",
}

Last updated