Skip to main content

How to Create a BRL Payment Order

This guide walks through the complete flow for accepting a payment in Brazilian Real (BRL).

When you create a BRL payment order, the API returns a QR code that the payer can scan to complete the payment. Once the payment is made, your application should periodically check the order status until it reaches a final state.

The complete flow consists of two steps:

  1. Create the payment order.
  2. Poll the order until the payment is confirmed.

Step 1 — Create Order​

⚠️ The amount field must always be expressed in USD, regardless of the settlement currency.

For example, if you want to collect the equivalent of 200 USD in Brazilian Real, set:

Request Examples​

curl -X POST "/api/v1/payment/order" \
-H "Content-Type: application/json" \
-H "x-api-key: <your_api_key>" \
-H "Authorization: Bearer <your_access_token>" \
-d '{
"amount": "200.00",
"currency": "BRL"
}'

Response Behavior​

A successful request returns 201 Created with the created payment order object.

The response include a qrData field containing QR code information.

Step 2 — Confirm Order​

After creating an order, its status must be polled until it reaches a final state.

You should periodically check the order status using:

curl -X GET "/api/v1/payment/order/9aa9124b-f7d8-49dc-8df6-53d5348ea383" \
-H "Content-Type: application/json" \
-H "x-api-key: <your_api_key>" \
-H "Authorization: Bearer <your_access_token>"

This endpoint should be used to verify payment completion state

Polling should continue until a terminal status is reached.

API Reference: Get Order By ID

Important Notes​

  • Payment orders initiate real financial operations. Ensure all fields are accurate before submitting.