Boleto via dLocal

Accept Boleto payments from customers in Brazil with dLocal as the payment service provider (PSP). The customer selects Boleto in your checkout and gets a Boleto on the dLocal payment page. They pay it at a bank, a lottery outlet, or an ATM, or through online banking.

Supported workflows

Before you begin

Complete these steps before you send your first Boleto payment through dLocal:

Set up a dLocal integration in your workspace. Follow the dLocal integration setup guide if you don’t have one yet.
Ask dLocal to enable Boleto on your dLocal account.
In the Payrails Portal, go to Settings → Integrations, open your dLocal integration, select Boleto under Payment methods, and save.
Add Boleto as a payment option in your workflow.

Request fields for dLocal

Send these fields in the authorize request, in addition to the standard authorize fields. Required fields must be present for the payment to succeed. Payrails sends Optional fields to the PSP when you include them.

Field	Status	Description
`amount.currency`	Required	Must be `BRL`. Payrails rejects other currencies.
`meta.customer.country`	Required	The customer’s country object. Payrails sends `BR` to dLocal for every Boleto payment, whatever `country.code` you send.
`meta.customer.name`	Required	Sent to dLocal as the payer name, together with `meta.customer.lastName`.
`meta.customer.email`	Required	Sent to dLocal as the payer email.
`meta.customer.identityCardNumber`	Required	The customer’s CPF or CNPJ. Sent to dLocal as the payer document.
`meta.customer.lastName`	Optional	Added to the payer name.
`meta.customer.phone`	Optional	Sent to dLocal as the payer phone number.
`meta.customer.birthDate`	Optional	Sent to dLocal as the payer’s date of birth.
`meta.customer.reference`	Optional	Sent to dLocal as the payer’s user reference.
`meta.order.billingAddress`	Optional	Sent to dLocal as the payer address. `meta.order.deliveryAddress` takes priority when both are present.
`meta.order.description`	Optional	Sent to dLocal as the payment description.
`meta.clientContext.clientType`	Optional	`desktop` or `mobile` sends the device type `WEB`, and `app` sends `APP`.
`meta.clientContext.ipAddress`	Optional	Sent to dLocal as the payer IP address.

Authorize a Boleto payment

Call authorize a payment with boleto as the paymentMethodCode. The response includes the redirect to the dLocal payment page, which shows the Boleto.

Authorize request

{
  "amount": {
    "value": "100.39",
    "currency": "BRL"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "boleto",
      "amount": {
        "value": "100.39",
        "currency": "BRL"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Ana",
      "lastName": "Souza",
      "email": "ana.souza@example.com",
      "identityCardNumber": "12345678909",
      "country": {
        "code": "BR"
      }
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

The payment stays pending until the customer pays the Boleto. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How dLocal handles Boleto

dLocal returns a redirect URL to its hosted payment page, where the customer gets the Boleto.
The payment stays pending until the customer pays the Boleto, and Payrails completes it from the dLocal notification. A Boleto paid in person can take up to one business day to confirm.
Payrails captures Boleto payments through dLocal immediately, so a successful payment is final. To return funds, refund the payment.
Each Boleto payment is a one-time, customer-initiated payment.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for dLocal

Authorize a Boleto payment

How dLocal handles Boleto

​Supported workflows

​Before you begin

​Request fields for dLocal

​Authorize a Boleto payment

​How dLocal handles Boleto

Supported workflows

Before you begin

Request fields for dLocal

Authorize a Boleto payment

How dLocal handles Boleto