Boleto

ℹ️
Vá para a Referência da API para acessar os exemplos completos de requisição e resposta.

Boleto Registrado

Com o objetivo de promover maior controle e segurança ao transacional de boletos no e-commerce e garantir mais confiabilidade e comodidade aos usuários, a FEBRABAN em conjunto com os bancos lançou a Nova Plataforma de Cobrança.

Desde 21 de julho de 2018 todos os boletos emitidos no e-commerce, obrigatoriamente, precisam ser registrados. Clique aqui para acessar o comunicado completo. Nessa modalidade, o lojista cria o boleto informando os dados do comprador, como nome, CPF ou CNPJ e endereço. Os dados do boleto ficam registrados em uma plataforma unificada.

Abaixo seguem os procedimentos de configuração de boletos em cada banco:

Bradesco
Banco do Brasil
Itaú API
Itaú Shopline *está sendo descontinuado pelo Itaú
Santander
Citibank

⚠️
Boleto Caixa está indisponível por tempo indeterminado.

⚠️
*O boleto Itaú Shopline será descontinuado pelo Itaú em 29 de outubro de 2025.

Criando uma transação de boleto

Veja abaixo a representação de um fluxo transacional padrão na criação de uma transação com boleto:

Para gerar um boleto, inclusive em ambiente Sandbox, é necessário fornecer dados do comprador como CPF ou CNPJ e endereço. Confira na Referência da API os exemplos completos de requisição e resposta para boleto.

Os parâmetros Payment.FineRate e Payment.FineAmount não devem ser utilizados em conjunto. A mesma regra se aplica aos parâmetros Payment.InterestRate e Payment.InterestAmount.

Conciliação de boletos

Para atualizar o status de um boleto para Pago, o Gateway de Pagamento deve receber dos bancos os arquivos CNAB com as liquidações referentes. Para habilitar sua loja a receber os arquivos bancários, basta seguir o procedimento descrito neste link.

Tipo de conciliação disponível para cada integração de boleto no Gateway de Pagamento:

Banco	Tipo de conciliação
Bradesco	Conciliação por API
Itaú Shopline	Conciliação por API
Banco do Brasil	Conciliação por arquivo
Itaú API	Conciliação por arquivo
Santander	Conciliação por arquivo
Citibank	Conciliação por arquivo

⚠️
Não é possível cancelar transações de boleto.

ℹ️
Importante
Há regras específicas para cada banco emissor. Consulte o tópico Regras Específicas por Banco Emissor para mais informações.