REST API Boleto Bancário | Nexi Documentation

Boleto Bancário, commonly referred to as Boleto, is one of the most widely used payment methods in Brazil. It allows customers to pay for purchases by generating a payment slip (boleto) which can be paid at banks, ATMs, post offices, lottery agents or online banking apps. Once paid, the confirmation is sent to the merchant, typically within 1 to 3 business days.

Boleto Bancário is a push-based, cash-like payment method and is preferred by customers without access to credit cards or those who prefer not to share card details online.

Get started

NEXI offers Boleto Bancário payment method via providers PPRO and PagBrasil.

Once you have decided to process via one of the providers and have onboarded follow the below steps:

Contact NEXI to activate Boleto Bancário payment method for your merchant profile.
Integrate by choosing the integration option tailored to your needs.

Integration options

Boleto Bancário payments can be integrated using all three NEXI

integration options. The provider used differs based on the integration type:

Hosted Payment Page via PPRO: Initiate a Hosted Payment Page by calling Create checkout session.

Hosted forms via PPRO: Initiate payment by calling Create payment with:

{
  ...
  "paymentMethods": {
    "type": "BOLETO",
    "integrationType": "HOSTED"
  }
}

Direct integration via PagBrasil: Initiate payment by calling Create payment with:
```
{
  ...
  "paymentMethods": {
    "type": "BOLETO",
    "integrationType": "DIRECT",
  }
}
```
In the response you receive a payment slip link (paymentMethods.boleto.paymentSlipLink) which needs to be shown to the customer on the confirmation page.

Refund payment

Refunds for Boleto Bancário transactions can be processed by referencing the original transaction. Call the Refund payment endpoint and pass the original payId.