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

Болето

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

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

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

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

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

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

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

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

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

~~Если для этого заказа доступна оплата через Boleto, вам потребуется предоставить следующие данные:~~ болето ~~объект в~~ настройки оплаты ~~атрибут.~~

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

ПОЧТА /{НОМЕР_ТЕЛЕФОНА_ИДЕНТИФИКАТОР}/сообщения

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

{
"recipient_type": "индивидуальный",
"к": "<PHONE_NUMBER> ",
"тип": "интерактивный",
"интерактивный": {
"тип": "order_details",
"тело": {
"текст": «Содержание вашего сообщения»
    },
"действие": {
"имя": "review_and_pay",
"параметры": {
"reference_id": "уникальный идентификатор ссылки",
"тип": «цифровые товары»,
"payment_type": "бр",
"payment_settings": [
          {
"тип": "болето",
"болето": {
"digitable_line": "03399026944140000002628346101018898510000008848"
            }
          }
        ],
"валюта": "БРЛ",
"Общая сумма": {
"ценить": 50000,
"компенсировать": 100
        },
"заказ": {
«статус»: "в ожидании",
"налог": {
"ценить": 0,
"компенсировать": 100,
"описание": «дополнительный текст»
          },
"предметы": [
            {
"retailer_id": "1234567",
"имя": "Торт",
"количество": {
"ценить": 50000,
"компенсировать": 100
              },
"количество": 1
            }
          ],
«Итого»: {
"ценить": 50000,
"компенсировать": 100
          }
        }
      }
    }
  }
}

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

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

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

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

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

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

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

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