Pix is a Brazilian payment method created by the Central Bank of Brazil. With pix, resources are transferred between accounts in just seconds securely with 24/7 availability.
Only available in Brazil
Payment
Pix is one of the payment methods available in the create payment service. The debt gets published in the bank to be paid by the customer using the QR code.
Status
| Status | Description |
|---|---|
| Opened | The order was created but not yet published in the bank. |
| Published | The order was published and is now awaiting payment. |
| Collected | The order was created and paid for. |
| Cancelled | The order was either canceled or expired. |
| Failed | Something went wrong and the order wasn't created. |
When the order status changes a webhook notification will be sent.
Workflow
In this section you can find information about pix workflow for different scenarios.
Successful:
Expired:
Delayed:
The API responds "Opened" status if the payment creation gets delayed, and in these cases, the response will lack locations data. Merchants can retry the payment order using the same request body.
Failed:
Testing environment Mocks
In order to test all scenarios in a testing environment, you can use the order amount to force the order status in the create payment response. For example, if the order amount is less than 5000. the order status will be "Published" and after a couple of minutes, it will change to "Collected". In the table below you can find other options.
Amount | Response status | Status change |
|---|---|---|
Amount <= 5.000 | Published | Collected |
5.001 - 10.000 | Published | |
10.001 - 15.000 | Failed | |
20.001 - 25.000 | Opened | Collected |
25.001 - 50.000 | Opened | Published |
50.001 - 55.000 | Opened | Failed |
Amount > 55.000 | Published | Collected |
When the order status changes a webhook notification will be sent.
Refund
Pix is also available in the refund service. It can be used to reimburse totally or partially previously collected orders.\
Status
| Status | Description |
|---|---|
| Opened | Refund order in process. |
| Refunded | Refund order completed. |
| Denied | Refund order denied. |
| Failed | Something went wrong the refund order failed. |
Testing environment Mocks
| Amount | Response status |
|---|---|
| Amount <= 2.500 | Refunded |
| 2.501 - 5.000 | Failed |
| Amount > 5.000 | Refunded |