PicPay via dLocal

Accept PicPay payments from customers in Brazil with dLocal as the payment service provider (PSP). The customer selects PicPay, scans a QR code on the dLocal payment page with the PicPay app and confirms the payment.

Supported workflows

Before you begin

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

Call authorize a payment with picPay as the paymentMethodCode. The response includes the redirect to the dLocal payment page, which shows the QR code.

Authorize request

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

The customer confirms the payment in the PicPay app. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How dLocal handles PicPay

dLocal returns a redirect URL to its hosted payment page, which shows the PicPay QR code.
The payment stays pending until the customer confirms it in the PicPay app, and Payrails completes it from the dLocal notification.
Payrails captures PicPay payments through dLocal immediately, so a successful payment is final. To return funds, refund the payment.
Each PicPay 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 PicPay payment

How dLocal handles PicPay

​Supported workflows

​Before you begin

​Request fields for dLocal

​Authorize a PicPay payment

​How dLocal handles PicPay

Supported workflows

Before you begin

Request fields for dLocal

Authorize a PicPay payment

How dLocal handles PicPay