On this page, you can find additional configuration for adding Boleto Bancário to your Drop-in integration.
Before you begin
This page assumes you have already:
API reference
Select which endpoint you're integrating:
This is the default with iOS Drop-in v5.0.0 or later.
Parameter name | Required | Description |
---|---|---|
shopperName | ![]() |
The shopper's first name and last name. |
socialSecurityNumber | ![]() |
The shopper's Cadastro de Pessoas Físicas (CPF) number or their Cadastro Nacional da Pessoa Jurídica (CNPJ) number. |
billingAddress | ![]() |
The postal address of the shopper. Recommended to increase conversion rates. |
deliverAt Checkout API v68 or later |
The due date of the payment, using ISO 8601 format in UTC. If this is in a weekend or national holiday, the shopper can pay the Boleto the next working day. By default, the shopper has five days to complete the payment. |
|
shopperEmail | The shopper's email address. This is used for sending the shopper a copy of the payment form. | |
shopperStatement | Free-text field with payment instructions. If you include this, make sure to state that you do not accept payments for a higher or lower amount than the original amount, or payments after the due date. |
If you leave the shopperStatement
empty, it is populated with the following default Portuguese text:
Não aceitar pagamento via cheque e/ou após a data do vencimento. | Do not accept payment by cheque and/or after the due date. |
Seu pedido será enviado somente após a confirmação do pagamento deste boleto, desde que não tenha divergência de valores entre o valor cobrado e o valor pago. | Your order will only be processed once the payment of this Boleto has been confirmed and as long as there is no difference between the payable and paid amounts. |
A falta de pagamento deste boleto não implica em qualquer multa ou juros e o pedido será automaticamente cancelado. | Failure to pay this boleto will not incur any penalty or interest and your order will be automatically cancelled. |
Não deposite nem faça transferência. | Do not pay by deposit or bank transfer. |
Drop-in configuration
You can add the following optional configuration for collecting the shopper details:
- If you already have the required shopper details, you can turn off the form sections where these details are collected.
- You can pre-fill some of the fields. To collect the missing details, turn on the corresponding form sections.
Parameter name | Description | Default |
---|---|---|
personalDetailsRequired |
Set to false if you have already collected the shopper's first name, last name, and CPF/CNPJ (socialSecurityNumber ). The CPF/CNPJ is a unique identifier similar to a social security number. The shopper can provide their Cadastro de Pessoas Físicas (CPF) number or their Cadastro Nacional da Pessoa Jurídica (CNPJ) number. |
true |
billingAddressRequired |
Set this to false if you have already collected the shopper's street, house number or name, city, postal code, and state or province. | true |
showEmailAddress |
Set this to false if you have already collected the shopper's email address. | true |
data |
Object to pre-fill shopper details on the form: socialSecurityNumber , shopperName , billingAddress , and shopperEmail as shown in the example below. |
Empty |
If you want to add optional configuration, include this in a configuration object. The following example shows how to configure Drop-in to remove the shopper details fields and prefill the form.
const boletoBancarioConfiguration = {
personalDetailsRequired: false, //turn personalDetails section on/off
billingAddressRequired: false, // turn billingAddress section on/off
showEmailAddress: false, // allow shopper to specify their email address
// Optionally pre-fill some fields, here all fields are filled:
data: {
firstName: 'José',
lastName: 'Silva',
billingAddress: {
city: 'São Paulo',
country: `BR`
houseNumberOrName: '952',
postalCode: '04386040',
stateOrProvince: 'SP',
street: 'Rua Funcionarios',
},
socialSecurityNumber: '56861752509',
shopperEmail: 'joses@test.com'
};
Include the boletoBancarioConfiguration
object when creating a configuration object for Drop-in:
Test and go live
Boleto Bancário is an offline payment method.
In the test environment, you can simulate a Boleto payment by promoting the pending payment to a sale.
- Log in to your test Customer Area.
- Go to Transactions > Offers.
- Select the PSP reference of the pending Boleto payment.
- Select the Promote this offer to a sale button.
Check the status of Boleto Bancário test payments in your Customer Area:
- Boletos that are pending or that have expired are under Transactions > Offers.
- Boletos that have been paid (including test offers that you manually promoted to sale) are under Transactions > Payments.
Test the reconciliation process by promoting test payments from offer to sale in your test Customer Area.
Before you can accept live Boleto Bancário payments, you need to submit a request for Boleto Bancário in your live Customer Area.