> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Pix

> Accept Pix instant payments in Brazil, where customers scan a QR code or copy a Pix code and confirm the payment in their banking app.

<picture noZoom>
  ![Pix logo](https://assets.payrails.io/img/logos/pix/logo.svg)
</picture>

Pix is the instant payment system of the Central Bank of Brazil. Customers pay by scanning a QR code, or copying a Pix code, in their banking app.

Payrails processes Pix through Adyen and dLocal. The flow is the same with each one, but the required request fields differ. Pick a PSP below for its setup steps and request examples. For recurring Pix payments, see [Pix Automático](https://docs.payrails.com/docs/integrations/payment-methods/pix-automatico).

## How a Pix payment works

Pix is a QR code payment method:

1. The customer selects Pix at checkout.
2. Payrails returns a redirect URL to a page that shows the Pix QR code.
3. The customer scans the code, or copies it, and confirms the payment in their banking app.
4. Payrails receives the final result from the PSP and updates the payment.

Each payment is single-use: the customer confirms every payment on its own. Payrails captures Pix payments immediately, so a successful payment is final. To return funds, [refund the payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md).

## Supported currencies and countries

Pix supports BRL (Brazilian real) as its only presentment currency.

Pix is available to customers based in:

<table>
  <thead>
    <tr><th>Regions</th><th>Countries</th></tr>
  </thead>

  <tbody>
    <tr><td>**Latin America**</td><td>🇧🇷 Brazil</td></tr>
  </tbody>
</table>

## Integrate Pix

Choose the PSP that processes Pix for you. Each guide covers the PSP-side setup, the Payrails configuration and the request fields that PSP requires.

> [card]
>
> Adyen logo
>
> AdyenPix via Adyen
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/pix/adyen.md)

> [card]
>
> dLocal logo
>
> dLocalPix via dLocal
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/pix/dlocal.md)

## Check PSPs

<table>
  <thead>
    <tr><th>Workflow</th><th>[Adyen](https://docs.payrails.com/docs/integrations/payment-methods/pix/adyen.md)</th><th>[dLocal](https://docs.payrails.com/docs/integrations/payment-methods/pix/dlocal.md)</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✖</td><td>✖</td></tr>
  </tbody>
</table>

To charge a customer on a schedule, use [Pix Automático](https://docs.payrails.com/docs/integrations/payment-methods/pix-automatico). Each Pix payment is a new customer-initiated payment.

## Ways to integrate Pix

* **Payrails SDK:** the [Web SDK](https://docs.payrails.com/docs/sdks/web.md) shows Pix when your workflow returns it as a payment option, and opens the QR code page for the customer. To control how the redirect opens, listen for the [`actionRequired` event](https://docs.payrails.com/docs/sdks/web/guides/action-required-event).
* **Payrails API:** call [lookup payment options](https://docs.payrails.com/docs/orchestration/payment-acceptance/lookup-payment-options.md), then authorize with `pix` as the `paymentMethodCode`. Each PSP guide lists the `meta` fields that PSP requires.

In both cases, confirm the final result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status. The customer pays in a separate app, so a return to your site isn't proof of payment.


## Related topics

- [Pix Automático](https://docs.payrails.com/docs/integrations/payment-methods/pix-automatico.md)
- [SmartPix](https://docs.payrails.com/docs/integrations/payment-methods/smart-pix.md)
- [Pix via Adyen](https://docs.payrails.com/docs/integrations/payment-methods/pix/adyen.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.