SmartPix via dLocal

Accept SmartPix payments with dLocal as the payment service provider (PSP).

Supported workflows

Before you begin

Complete these steps before you send your first SmartPix 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 SmartPix on your dLocal account.
In the Payrails Portal, go to Settings → Integrations, open your dLocal integration, select SmartPix under Payment methods, and save.
Add SmartPix 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 SmartPix 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.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 SmartPix payment

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

Authorize request

{
  "amount": {
    "value": "100.39",
    "currency": "BRL"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "smartPix",
      "amount": {
        "value": "100.39",
        "currency": "BRL"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Pedro",
      "lastName": "Almeida",
      "email": "pedro.almeida@example.com",
      "identityCardNumber": "12345678909",
      "country": {
        "code": "BR"
      }
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

After the customer authorizes the payment, they return to your success or error URL. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How dLocal handles SmartPix

dLocal returns a redirect URL to its hosted payment page. The payment stays pending until the customer authorizes it, and Payrails completes it from the dLocal notification.
dLocal rejects cancel requests for SmartPix in every payment state, so Payrails can’t cancel a SmartPix payment. To return funds after a successful payment, refund it.
For recurring Pix through dLocal, use Pix Automático. Each SmartPix payment is a new 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 SmartPix payment

How dLocal handles SmartPix

​Supported workflows

​Before you begin

​Request fields for dLocal

​Authorize a SmartPix payment

​How dLocal handles SmartPix

Supported workflows

Before you begin

Request fields for dLocal

Authorize a SmartPix payment

How dLocal handles SmartPix