Boleto | Документация для разработчиков

Болето

Обновлено: 14 ноября 2025 г

API платежей также позволяет компаниям принимать платежи от своих клиентов через WhatsApp с помощью Boleto.

При использовании этой интеграции WhatsApp лишь обеспечивает связь между продавцами и покупателями. Продавцы несут ответственность за интеграцию с платежной системой, с помощью которой они могут генерировать коды Boleto и подтверждать свои платежи.

Прежде чем начать

Ознакомьтесь с API заказов . Заказы — это точка входа для сбора платежей в WhatsApp.Для генерации кодов Boleto и автоматической сверки платежей вам потребуется существующая интеграция с платежным сервисом.Статус заказа необходимо обновить сразу после совершения платежа.

Этапы интеграции

Следующая диаграмма последовательности демонстрирует типичную интеграцию с системой Boleto.

1. Отправьте сообщение с подробной информацией о заказе

Полное руководство по интеграции находится на странице API заказов .

Если для этого заказа доступна оплата через Boleto, вам потребуется указать Boleto в payment_settings .

Конечная точка

POST /{ PHONE_NUMBER_ID }/ messages

Пример полезной нагрузки

{
 "recipient_type"
 : "individual" , "to"
 : " " , "type"
 : "interactive" , "interactive"
 : { "type"
 : "order_details" , "body"
 : { "text"
 : "Содержание вашего сообщения" },
 "action"
 : { "name"
 : "review_and_pay" , "parameters"
 : { "reference_id"
 : "unique-reference-id" , "type"
 : "digital-goods" , "payment_type"
 : "br" , "payment_settings"
 : [ {
 "type"
 : "boleto" , "boleto"
 : { "digitable_line"
 : "03399026944140000002628346101018898510000008848" }
 }
 ],
 "currency"
 : "BRL" , "total_amount"
 : { "value"
 : 50000 , "offset"
 : 100 },
 "order"
 : { "status"
 : "pending" , "tax"
 : { "value"
 : 0 , "offset"
 : 100 , "description"
 : "optional text" },
 "items"
 : [ {
 "retailer_id"
 : "1234567" , "name"
 : "Cake" , "amount"
 : { "value"
 : 50000 , "offset"
 : 100 },
 "quantity"
 : 1 }
 ],
 "subtotal"
 : { "value"
 : 50000 , "offset"
 : 100 }
 }
 }
 }
 }
 }

Объект параметров

Название поля	Необязательный?	Тип	Описание
`настройки оплаты`	Необязательный	Объект «Настройки платежей»	Список объектов конфигурации, связанных с платежами.

Настройки оплаты

Название поля	Необязательный?	Тип	Описание
`тип`	Необходимый	Нить	Должно быть `boleto` .
`болето`	Необходимый	Объект Болето	Объект Boleto, который будет использоваться для отображения этой опции покупателям в процессе оформления заказа.

Объект Болето

Название поля	Необязательный?	Тип	Описание
`цифровая_линия`	Необходимый	Нить	Цифровой код Boleto, который будет скопирован в буфер обмена при нажатии пользователем кнопки призыва к действию Boleto.

2. Отправить уведомление о статусе заказа

После подтверждения платежа необходимо отправить обновление статуса заказа. Следуйте инструкциям по интеграции на странице API заказов .