Banco do Brasil
Please refer to the API Reference for the full request and response examples.
The Banco do Brasil boleto integration must use the BancoDoBrasil3 provider, valid from 03/05/2026.
How it works
- After selecting a product, the shopper chooses the Banco do Brasil Registered Boleto payment method;
- The merchant sends a request to Cielo calling the corresponding payment method;
- Cielo returns a URL containing the boleto image.
Registration and setup with Banco do Brasil
1. BB environment
To enable the registered boleto product, contact your Banco do Brasil relationship manager and provide the following information:
| Data | Format |
|---|---|
| Return URL (merchant site) | https://www.pagador.com.br |
| Return file format | (X) CBR643 |
| Return method | (X) Mainframe – for companies with their own system that do not use GFN. |
After completing the registration, the merchant will receive a document.
2. Obtain credentials on Banco do Brasil portal
Access the Banco do Brasil portal to get your credentials and follow these steps:
• Create an account on the BB portal;
• Create an application (Charges API);
• Perform testing and move to production.
3. Register credentials
To use the BancoDoBrasil3 provider, you must register the following credentials with Cielo Support:
| Field | Value |
|---|---|
| Application Key | AppKey |
| Username | ClientId |
| Password | ClientSecret |
Boleto configuration on Cielo
Registration data
You must provide the following information to Cielo Support:
| Data | Description | Format | Observation |
|---|---|---|---|
Branch | Branch code | 4 digits | Only the four branch numbers are required, do not include the check digit |
Account | Account number | 7 digits | Hyphen required |
Wallet | wallet number and variation*. | 5 digits in the format "XX/XX". | Example: "17/27". |
Agreement | E-commerce agreement | 6 digits | It is the same value as Reconciliation (Billing agreement) provided by the bank. |
Our Number | Boleto number that allows its identification with Banco do Brasil. It is an incremental counter. | 5 digits | Enter "10000" – For each boleto issued, this number increases by +1. |
Due date | Boleto validity period | 2 digits in the format "XX". | This is the default value if no other value is sent via API. |
Instructions | Information displayed on the boleto | 50 characters | Only numbers and letters A-Z are allowed. No special characters or more than one space between words. |
AppKey | Affiliation signature provided by Banco do Brasil. Available on the BB portal. | 32 digits | It is a hexadecimal sequence. |
ClientId | Banco do Brasil identifier. | -- | Credential provided by Banco do Brasil. |
ClientSecret | Banco do Brasil key. | -- | Credential provided by Banco do Brasil. |
*Wallet variation for Banco do Brasil: grouping parameter for boletos within the same wallet. It allows the merchant to group its boletos according to different business models (branches, points of sale, etc.).
The merchant must include in the API contract the shopper's data (name, CPF, and full address).
Boleto reconciliation
Currently, the registered boleto for Banco do Brasil does not perform automatic status updates
Updated about 12 hours ago