Pix via dLocal

Accept Pix payments from customers in Brazil with dLocal as the payment service provider (PSP). The customer selects Pix, goes to the dLocal payment page and pays from their banking app.

Supported workflows

Before you begin

Complete these steps before you send your first Pix 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 Pix on your dLocal account.
In the Payrails Portal, go to Settings → Integrations, open your dLocal integration, select Pix under Payment methods, and save.
Add Pix 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. Payrails checks Required fields and returns an error when one is missing. Fields required by the PSP pass the Payrails checks but the PSP can decline the payment without 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 Pix 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 by dLocal	The customer’s CPF or CNPJ. Sent to dLocal as the payer document.
`meta.customer.lastName`	Recommended	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.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.ipAddress`	Optional	Sent to dLocal as the payer IP address.

Authorize a Pix payment

Call authorize a payment with pix as the paymentMethodCode. The response includes the redirect to the dLocal payment page.

Authorize request

{
  "amount": {
    "value": "150.00",
    "currency": "BRL"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "pix",
      "amount": {
        "value": "150.00",
        "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 customer pays in their banking app. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How dLocal handles Pix

dLocal returns a redirect URL to its hosted Pix payment page. The payment stays pending until the customer pays, and Payrails completes it from the dLocal notification.
Payrails captures Pix payments through dLocal immediately, so a successful payment is final. To return funds, refund the payment.
Saving the instrument and merchant-initiated transactions (MIT) aren’t available. For recurring Pix through dLocal, use Pix Automático.

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 Pix payment

How dLocal handles Pix

​Supported workflows

​Before you begin

​Request fields for dLocal

​Authorize a Pix payment

​How dLocal handles Pix

Supported workflows

Before you begin

Request fields for dLocal

Authorize a Pix payment

How dLocal handles Pix