Banco do Brasil
Vá para a Referência da API para acessar os exemplos completos de requisição e resposta.
AtençãoA partir de 31/12/2025, o provedor BancoDoBrasil2 será descontinuado. E a nova integração de boleto Banco do Brasil estará disponível com o provedor BancoDoBrasil3.
Como funciona
- O comprador, após escolher o produto na loja, seleciona a forma de pagamento Boleto Registrado Banco do Brasil.
- A loja envia para a Cielo uma requisição chamando o meio de pagamento correspondente.
- A Cielo retornará uma URL contendo a imagem do Boleto.
Cadastro e configuração com o Banco do Brasil
1. Ambiente BB
Para habilitar o produto boleto registrado, entre em contato com o gerente de relacionamento do Banco do Brasil e forneça as informações abaixo:
| Dado | Formato |
|---|---|
| URL (site) retorno à loja | https://www.pagador.com.br |
| Formato arquivo retorno | (X) CBR643 |
| Meio de retorno | (X) Mainframe – para empresa com sistema próprio, que não usam o GFN. |
Ao concluir o credenciamento, o estabelecimento receberá um documento.
2. Obter credenciais no portal do Banco do Brasil
Acesse o portal do Banco do Brasil para obter suas credenciais e siga estas etapas:
• Criar cadastro no portal BB;
• Criar uma aplicação (API de cobranças);
• Realizar testes e envio para produção.
3. Cadastrar credencias
Para usar o provedor BancoDoBrasil3, é obrigatório cadastrar as credenciais abaixo com o suporte Cielo:
| Campo | Valor |
|---|---|
| Assinatura de Afiliação | AppKey |
| Username | ClientId |
| Senha | ClientSecret |
Configuração do boleto na Cielo
Dados de cadastro
Você deve informar ao suporte Cielo os seguintes dados:
| Dados | Descrição | Formato | OBS |
|---|---|---|---|
Agência | Código agência | 4 dígitos | Apenas os quatro números da agência são obrigatórios, sem incluir dígito |
Conta: | Conta corrente | 7 dígitos | Hífen obrigatório |
Carteira: | Número da carteira e variação*. | 5 dígitos no formato "XX/XX". | Exemplo: "17/27". |
Convênio | Convênio de comércio eletrônico | 6 dígitos | É o mesmo valor de Conciliação (Convênio de cobrança) fornecido pelo banco. |
Nosso Número | Número do boleto que permite sua identificação junto ao BB. É um contador incremental | 5 dígitos | Inserir "10000" - A cada emissão de boleto esse numero aumenta em +1. |
Vencimento | Prazo de validade do boleto | 2 dígitos no formato "XX". | É o valor padrão, se nenhum outro valor for enviado via API |
Instruções | Informações exibidas no boleto | 50 dígitos | Somente números e letras de A-Z, não pode haver caracteres especiais ou mais de um espaçamento entre cada palavra |
AppKey | Assinatura de afiliação fornecida pelo Banco do Brasil. Disponível no portal BB. | 32 dígitos | É uma sequência hexadecimal. |
ClientId | Identificador no Banco do Brasil | -- | Credencial fornecida pelo Banco do Brasil. |
ClientSecret | Chave no Banco do Brasil | -- | Credencial fornecida pelo Banco do Brasil. |
*Variação da carteira para o Banco do Brasil: parâmetro de agrupamento de boletos dentro de uma mesma carteira, permite que a loja agrupe seus boletos, de acordo com modelos de negócios diferentes (filiais, pontos de venda, etc.).
OBS: A loja deverá obrigatoriamente enviar no contrato da API os dados (nome do comprador, CPF e endereço completo).
Conciliação de boletos
NO MOMENTO, O BOLETO REGISTRADO BANCO DO BRASIL NÃO REALIZA ATUALIZAÇÃO DE STATUS AUTOMÁTICA
Updated 13 days ago