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

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:

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

1. 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.
2. The consumer will finalize the payment process on the redirected page.

SCAN_CODE

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

Handling the payment result

REDIRECT

1. Once the consumer has confirmed the payment, they are redirected to the returnUrl provided in the initial payment charge creation request.
2. 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.
3. 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

1. You'll be notified of the payment outcome via Webhook.
2. You can check the payment status at any time by making a GET /v1/payment-charges/{paymentChargeId}.
3. Use the Status that you received to display the payment outcome to the consumer.

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for Pix, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_5ChenWBwW8xARvJ3GccAx",
    "type": "PASSTHROUGH_WALLET"
}