Pix is the first instant payment system available to Brazilian consumers. Developed by the Central Bank of Brazil it connects 750 financial institutions with over 500,000 active consumer accounts. Learn more about Pix.

Payment Method Properties


Markets	`BR`
Processing currencies	`BRL`
Consumer currencies	`BRL`
Settlement currencies	`BRL`
Authentication methods	`REDIRECT` `SCAN_CODE`
Minimum payment amount	1.00 BRL
Maximum payment amount	250,000.00 BRL
Recurring payments	No (to be launched on June 2025)
Separate captures	No
Refund	Full - Partial - Multiple
Refund validity	365 days
Chargeback	Yes
Sandbox availability	PPRO mock processor

Make a Pix payment

Pix is available through our standardized REDIRECT and SCAN_CODE flows. Enabling you to offer a seamless desktop or in-store QR code to mobile handoff.

To create a Pix payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:

Data Field	Description
paymentMethod	`PIX`
paymentDescriptor	A descriptor for the payment.
amount.value	The amount to be paid in the smallest units of the currency used.
amount.currency	`BRL`
consumer.name	Full name of the consumer.
consumer.country	The country where the consumer is shopping.
consumer.email	Email of the consumer.
consumer.taxIdentification	CPF (individual tax Id) or CNPJ (business tax Id).
authenticationSettings: REDIRECT settings.returnUrl	Add the url where the consumer should be redirected to after they complete the payment. Required for the `REDIRECT` payment flow.
webhooksUrl	You should include the endpoint url where you want to receive webhooks for updates to the payment charge.

Request:

{
  "paymentMethod": "PIX",
  "amount": {
    "value": 1000,
    "currency": "BRL"
  },
  "consumer": {
    "name": "John Smith",
    "country": "BR",
    "email": "[email protected]",
    "taxIdentification": 93248261668
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response (see potential responses in the API Reference) with the available authentication methods.

{
  "id": "charge_X0O78tadFHrZCbGhkycPk",
  "status": "AUTHENTICATION_PENDING",
  
  // ...
  
  "authenticationMethods": [
    {
      "type": "REDIRECT",
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      }
    },
    {
      "type": "SCAN_CODE",
      "details": {
        "codePayload": "pix://open/paymentrequest?amount=1000&currency=BRL&from=QR",
        "codeImage": "https://qr.ppro.com/image.png?payload=aWQ9YWJjJmFtb3Vuk9VVNEJmZyb209UVI",
        "codeDocument": "cdn.ppro.com//linktocodedocument",
        "scanBy": "2023-03-26T20:24:27Z",
        "codeType": "QR"
      }
    }
  ]
}

Pick the desired authentication method

REDIRECT

Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
The consumer will finalize the payment process on the redirected page.

SCAN_CODE

Render the QR code using one of the techniques available.
The consumer will scan the QR code to complete the payment.

Handling the payment result

REDIRECT

Once the consumer has confirmed the payment, they are redirected to the returnUrl provided in the initial payment charge creation request.
After the consumer is redirected back to your site, check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
Webhooks are also sent to inform you of the payment outcome. If the shopper closes the browser and doesn't return to your website, you can rely on webhooks to receive the payment result.

SCAN_CODE

Check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
Webhooks are also sent to inform you of the payment outcome.