Pix
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 |
Authentication timeout | |
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 |
Disputes | Yes |
Sandbox availability | PPRO mock processor |
Make a Pix payment
Pix payments follow our standardized REDIRECT
and SCAN_CODE
payment flows. Enabling you to offer a seamless desktop or in-store QR code to mobile handoff experience. We recommend including all relevant settings for any authentication methods you support.
To create a Pix payment, you'll need to provide the following data at minimum when calling our payment charges API:
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. |
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 with the available authentication methods:
{
"id": "charge_Y3JVzvEaJpvG53xd2R2Zt",
"paymentMethod": "PIX",
"paymentMedium": "ECOMMERCE",
"scheduleType": "UNSCHEDULED",
"instrumentId": "instr_Asu0ig2PXXZSiNrhY44A5",
"currency": "BRL",
"country": "BR",
"status": "AUTHENTICATION_PENDING",
"consumer": {
"name": "John Smith",
"email": "[email protected]",
"country": "BR",
"taxIdentification": "93248261668"
},
"authenticationMethods": [
{
"details": {
"requestUrl": "https://redirection-target.ppro.com",
"requestMethod": "GET"
},
"type": "REDIRECT"
}
],
"authorizations": [
{
"id": "authz_aPobet0FNZNU1bYqfexFd",
"amount": 1000,
"status": "AUTHENTICATION_PENDING",
"createdAt": "2025-06-21T08:34:20.766Z",
"updatedAt": "2025-06-21T08:34:20.766Z"
}
],
"captures": [],
"refunds": [],
"voids": [],
"createdAt": "2025-06-21T08:34:20.114Z",
"updatedAt": "2025-06-21T08:34:20.766Z",
"_links": {
"authorizations": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/authorizations"
},
"captures": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/captures"
},
"refunds": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/refunds"
},
"voids": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/voids"
}
}
}
Pick the desired authentication method
REDIRECT
- Redirect your consumer to the returned
$.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl
.
For example, with the value ofhttps://redirection-target.ppro.com/
using the returned$.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod
HTTP method. - The consumer will be presented with the payment slip (voucher) and instructions to complete the payment.
SCAN_CODE
- Render the code using one of the techniques available.
- The consumer will scan the code to complete the payment.
Handling the payment result
REDIRECT
- After the consumer completes the payment, they are redirected to the
returnUrl
specified in the payment charge creation request. - Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned
status
field to determine and display the final payment outcome to the consumer. - Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.
SCAN_CODE
- You'll be notified of the payment outcome via Webhook.
- You can check the payment status at any time by making a GET /v1/payment-charges/{paymentChargeId}.
- 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_Asu0ig2PXXZSiNrhY44A5",
"type": "PASSTHROUGH_WALLET"
}
Updated 6 days ago