Boletos

Com a API de Boletos é possível gerar boletos únicos ou parcelados.

A API de boletos possibilita a criação de boletos únicos e boletos parcelados para um mesmo cliente, boletos em lote para múltiplos clientes e a assinatura dos eventos de boletos através de webhooks.

Casos de Uso

  • Utilizar a API de Boletos do BTG Empresas como meio de pagamento em um e-commerce.
  • Criar boletos bancários a partir de um ERP.
  • Integração com sistemas de contas a receber.
  • Aplicativos móveis com funcionalidade de emissão e gerenciamento de boletos bancários.

Segurança

📘

BTG Id

O BTG Id é o authorization server do BTG Pactual, responsável pelos fluxos de autenticação, autorização e emissão de acess tokens com escopos necessários para consumir a API.

O token para consumo da API de Boletos deve ser gerado utilizando o fluxo Authorization Code. Abaixo os escopos necessários:

Escopo

Descrição

openid

Escopo que dá permissão a consulta do perfil do usuário BTG com acesso a conta.

empresas.btgpactual.com/bank-slips

Escopo que dá permissão para criação e consulta de boletos.

empresas.btgpactual.com/bank-slips.readonly

Escopo que dá permissão para consulta de boletos e recebimento de webhooks.

Recursos Disponíveis

Os recursos da API de Boletos estão documentados no API Reference, que pode ser acessado através do link abaixo.

📘

API Reference

Boletos API

Eventos

A API de Boletos disponibiliza uma série de eventos de webhook, que podem ser utilizados para receber atualizações das transições de status dos boletos criados:

Identificação do Evento

Evento

Descrição

bank-slips.created

Boleto criado

Ocorre quando um boleto é criado e registrado na CIP.

bank-slips.failed

Falha ao criar boleto

Ocorre quando há uma falha na criação ou registro do boleto na CIP.

bank-slips.updated

Boleto atualizado

Ocorre quando um boleto é atualizado.

bank-slips.update_failed

Falha ao atualizar boleto

Ocorre quando uma solicitação de atualizaçao de um boleto falha.

bank-slips.canceled

Boleto cancelado

Ocorre quando um boleto é cancelado.

bank-slips.cancel_failed

Falha ao cancelar boleto

Ocorre quando uma solicitação de cancelamento de boleto falha.

bank-slips.paid

Boleto pago

Ocorre quando um boleto é pago.

bank-slips.reversed

Boleto estornado

Ocorre quando um boleto é estornado.

bank-slips.rejected

Boleto rejeitado

Ocorre quando o pagamento de um boleto é rejeitado.


Did this page help you?