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:

EscopoDescrição
openidEscopo que dá permissão a consulta do perfil do usuário BTG com acesso a conta.
empresas.btgpactual.com/bank-slipsEscopo que dá permissão para criação e consulta de boletos.
empresas.btgpactual.com/bank-slips.readonlyEscopo 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 EventoEventoDescrição
bank-slips.createdBoleto criadoOcorre quando um boleto é criado e registrado na CIP.
bank-slips.failedFalha ao criar boletoOcorre quando há uma falha na criação ou registro do boleto na CIP.
bank-slips.updatedBoleto atualizadoOcorre quando um boleto é atualizado.
bank-slips.update_failedFalha ao atualizar boletoOcorre quando uma solicitação de atualizaçao de um boleto falha.
bank-slips.canceledBoleto canceladoOcorre quando um boleto é cancelado.
bank-slips.cancel_failedFalha ao cancelar boletoOcorre quando uma solicitação de cancelamento de boleto falha.
bank-slips.paidBoleto pagoOcorre quando um boleto é pago.
bank-slips.reversedBoleto estornadoOcorre quando um boleto é estornado.
bank-slips.rejectedBoleto rejeitadoOcorre quando o pagamento de um boleto é rejeitado.