PIX

Here are few tips and tricks in regards to processing Payments and Payouts using PIX payment method in Brazil.

Payments

Using the Payments API, send a valid request to rest/payment endpoint to create a valid
PIX code to be paid.

Once you have received a valid response, display the pix_qrcode value you have received in the response to the customer to copy and paste to their banking platform. You may also choose to display this as QR Code on web payments, where it's scannable by mobile.

Status updates will come as Postback-Webhook notification, however, we suggest to use Status Update endpoint to reduce this delay in status updates.

PIX is an instant payment method, however, due to there being intermediaries in between the merchant and the end customer, status updates may take from 1 to 8 mins to arrive to your platform.

Send POST request to status update endpoint every 5 to 10 seconds, or interval that best fits your application's needs.

POST /rest/status_update

{
  "api_key": "yourmerchantapikey",
  "transaction_id": "idofthetransaction"
}

Response will reflect the latest status of the transaction fetched from Central Bank of Brazil in real time. You will also receive a Postback-Webhook notification if this request has changed the transaction status.

Customization Options

When generating PIX QR Codes, you can customize:

Expiration times (default is 12 hours)
Lock the payment to a specific payer

We suggest to customize the expiration time according to your needs. Parameters can be found in the Payments API parameter list.

We suggest to lock the payment to a specific person, if their Tax ID (CPF or CNPJ) is known ahead of the time, to reduce fraud.

Payouts

Using the Payouts API send a valid request to rest/payouts endpoint to create a outgoing payment request from your account, to your customer's.

Once you have received a valid response, with a transaction in state of pending, you will now have to wait for status updates.

Status updates will come as Postback-Webhook notification, however, we suggest to use Status Update endpoint to reduce this delay in status updates.

PIX is an instant payment method, however, due to there being intermediaries in between the merchant and the end customer, status updates may take from 1 to 8 mins to arrive to your platform.

Send POST request to status update endpoint every 5 to 10 seconds, or interval that best fits your application's needs.

POST /rest/status_update

{
  "api_key": "yourmerchantapikey",
  "transaction_id": "idofthetransaction"
}