Интеграция

Создание счета на оплату

Метод для создания счета на оплату покупателю

Интеграция

Метод для создания счета на оплату покупателю

Дата публикации: 17 мая 2022

Данный метод предназначен для создания счета на оплату покупателю. В случае корректного составления запроса создается ссылка на оплату, которую необходимо отправить покупателю.

Формат запроса
POST — https://pay.modulbank.ru/api/v1/bill/

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

merchant;Идентификатор магазина, который выдается в личном кабинете на этапе интеграции;Да;– Строка (максимум 128 символов) – Допускаются только печатные ASCII¬ символы amount;Сумма платежа;Да;– Вещественное число, два знака после точки – Формат: «100» или «200.45» description;Описание платежа;Да; Строка (максимум 250 символов) testing;Флаг тестового режима, в котором можно совершать произвольное количество транзакций с использованием тестовых карт. При включенной интеграции с кассой по тестовым оплатам чеки не формируются;Нет;– Значение логического типа: – 1 — тестовый платеж, – 0 — реальный платеж – По умолчанию реальные платежи client_email;E-mail клиента. Флаг отправки письма с уведомлением о выставленном счете;Нет;– Строка (максимум 64 символа) – Если указано это поле и передано "send_letter"=1, то клиенту будет отправлено письмо с уведомлением о выставлении счета client_name;Имя и фамилия клиента;Нет;– Строка (максимум 100 символов) custom_order_id;Идентификатор заказа, который будет отображаться покупателю;Нет;– Строка (максимум 50 символов) lifetime;Срок актуальности счета в секундах. По истечению счет будет недоступен к оплате;Нет;– Целое число – По умолчанию срок актуальности равен одной неделе send_letter;Флаг отправки письма с уведомлением о выставленном счете;Нет;– Значение логического типа: – 1 — отправить письмо со ссылкой на оплату, – 0 — не отправлять письмо – Если указать этот флаг (и client_email), то клиенту будет отправлено письмо, в котором будет ссылка на оплату receipt_contact;Еmail получателя чека;Да(если в ЛК включена удаленная регистрация чеков через онлайн-кассу);– Строка (максимум 64 символа) receipt_items;Позиции чека;Да(если в ЛК включена удаленная регистрация чеков через онлайн-кассу);– json-объект с позициями чека – Обязательные поля и пример json-объекта описаны в разделе <a>«Отправка чеков»; unix_timestamp;Текущее дата и время;Да;– UNIX Time salt;Случайная величина;Нет;– Строка (максимум 32 символа) – Допускаются только печатные ASCII¬ символы signature;Криптографическая подпись;Да;– Строка (40 символов в нижнем регистре) – Алгоритм вычисления вычисления подписи описан в разделе «Алгоритм вычисления поля signature» – Пример: 78d9e7d4ec844885790f185ce0e7a60374d01cbc reusable;Одноразовый/многоразовый счет Многоразовый счет предоставляет ссылку, по которой оплата может быть проведена неограниченное количество раз любыми покупателями. Для многоразового счета не указываются поля send_letter, receipt_contact, client_email и lifetime, так как конечного получателя для счета нет. Email указывает сам покупатель на платежной странице;Нет;– Значение логического типа – 1 — многоразовый, 0 — одноразовый – По умолчанию не отправляется callback_url;Адрес, на который будет отправлено уведомление в случае успешной оплаты;Нет;– Строка (максимум 128 символов) – Формат: url encode callback_on_failure;Включение/отключение отправки уведомления, когда операция завершилась неуспешно;Нет;– Значение логического типа – 1 — отправлять, 0 — не отправлять – По умолчанию не отправляется start_recurrent;Указывает, что карту, с которой проводится транзакция, нужно сохранить в карточном хранилище для последующих рекуррентных платежей по ней. Для последующих рекуррентных платежей по этой карте будет необходимо использовать ID этой транзакции. <a>(см. 08 Рекуррентные платежи) Доступно только после одобрения заявки на проведение рекуррентных платежей в личном кабинете;Нет;– Значение логического типа – 1— рекуррентная транзакция, 0 или отсутствует — не рекуррентная транзакция – По умолчанию не отправляет show_payment_methods;Указывает, какие из доступных платежный методов (карты, СБП) показывать покупателю;Нет;– Строка – ["sbp"] — только СБП – ["card"] — только карты – ["sbp", "card"] — оба метода – По умолчанию выводятся все доступные метод success_url;Адрес для переадресации плательщика в случае успешной оплаты;Да;– Строка (максимум 128 символов) *Если хотите использовать страницу успешной оплаты Модульбанка, то укажите в этом поле: https://pay.modulbank.ru/success preauth; Указывает, что оплата будет двухстадийной. Подробнее в разделе"Холдирование"; Нет; – Значение логического типа: • 1— запрос с холдированием, • 0 или отсутствует— одностадийный платёж – По умолчанию не отправляется

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

{
"signature": "2aad6f9bb04458b39b77811a7efcfbc10f0b09d8",
"amount": 83,
"send_letter": "1",
"unix_timestamp": 1542081557,
"testing": "1",
"description": "Оплата товара в магазине myawesomesite.com",
"salt": "GfudKOAsXobWVpNovJHCreKmJXNkLqtf",
"client_email": "test@test.ru",
"merchant": "ad25ef06-1824-413f-8ef1-c08115b9b979"
}

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

{
"bill":
{ "amount": "83",
"client_email": "test@test.ru",
"created_datetime": "2018-11-13 05:19:49",
"currency": "RUB",
"description": "Оплата товара в магазине myawesomesite.com.",
"expired": 0,
"id": "GGgEgDY3fvrDpVb25HMg2o",
"merchant": "ad25ef06-1824-413f-8ef1-c08115b9b979",
"number": 138,
"paid": 0,
"send_letter": 1,
"testing": 1,
"transaction": {},
"url": "https://pay.modulbank.ru/bill-GGgEgDY3fvrDpVb25HMg2o" },
"status": "ok"
}

(i) Перейдя по ссылке, пришедшей в поле "url", плательщик попадает на страницу оплаты.

Возможные статусы платежа на оплату:

Читайте также:

Получение списка транзакций

Получение информации о выставленном счете на оплату

Вам помогла эта статья?