> ## 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 via Adyen

> Set up Pix payments through Adyen in Payrails, with a Payrails-hosted page that shows the customer the Pix QR code.

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

<picture noZoom>
  ![Adyen logo](https://assets.payrails.io/img/logos/adyen/logo-full-bleed.svg)
</picture>

Accept [Pix](https://docs.payrails.com/docs/integrations/payment-methods/pix) payments from customers in Brazil with Adyen as the payment service provider (PSP). The customer selects Pix, scans the QR code with their banking app and confirms the payment there.

## Supported workflows

<table>
  <thead>
    <tr><th>Workflow</th><th>Supported</th></tr>
  </thead>

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

## Before you begin

Complete these steps before you send your first Pix payment through Adyen:

1. Set up an Adyen integration in your workspace. Follow the [Adyen integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/adyen.md) if you don't have one yet.
2. Ask Adyen to enable Pix on your Adyen merchant account.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Adyen integration, select **Pix** under **Payment methods**, and save.
4. Add Pix as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in your workflow.

## Request fields for Adyen

Send these fields in the authorize request, in addition to the standard [authorize fields](https://docs.payrails.com/reference/authorizeaction.md). **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.name`, `meta.customer.lastName` | Optional | Sent to Adyen as the shopper name. |
| `meta.customer.identityCardNumber` | Optional | The customer's CPF or CNPJ. Sent to Adyen as the shopper's tax ID. |
| `meta.customer.email` | Optional | Sent to Adyen as the shopper email. |
| `meta.customer.country.code` | Optional | Sent to Adyen as the country code, for example `BR`. |
| `meta.order.lines` | Optional | Sent to Adyen as line items. |

## Authorize a Pix payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `pix` as the `paymentMethodCode`. The response includes the redirect to the QR code page.

```json Authorize request theme={null}
{
  "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](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status before you fulfill the order.

## How Adyen handles Pix

* Adyen returns the Pix QR code, and Payrails turns it into a redirect to a Payrails-hosted page that shows the code to the customer.
* The payment stays pending until the customer pays. Payrails completes it when Adyen sends the authorization notification.
* Adyen captures Pix payments automatically. When Adyen confirms the authorization, Payrails also records the capture, so the payment completes in one step.
* To return funds, refund a completed Pix payment.


## Related topics

- [Pix](https://docs.payrails.com/docs/integrations/payment-methods/pix.md)
- [Bancontact via Adyen](https://docs.payrails.com/docs/integrations/payment-methods/bancontact/adyen.md)
- [FPX via Adyen](https://docs.payrails.com/docs/integrations/payment-methods/fpx/adyen.md)


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