Payment Orders Overview
A payment order represents a financial collection request that a store or branch initiates on behalf of a payer. It defines the amount (in USD) and the currency the payer will use to settle the transaction (BRL, ARS, or USDT).
Creating a payment order starts the payment flow. The response will include a QR code that payer uses to complete the transaction. The order tracks its own lifecycle from pending through completed, underpaid, cancelled, or under_dispute.
Endpoint
POST /payment/order
API Reference: Create Payment Order
Authentication
This endpoint requires a valid x-api-key and a Bearer Token issued to a store or branch role in headers.
x-api-key: <your_api_key>
Authorization: Bearer <access_token>
supervisor user requests will be rejected
See the Authentication Guide to see more details.
Supported Currencies
| Currency | Description |
|---|---|
BRL | Brazilian Real |
ARS | Argentine Peso |
USDT | Tether stablecoin |
Order Statuses
| Status | Meaning |
|---|---|
pending | Initial order state |
completed | Payment confirmed order fulfilled |
underpaid | Transaction found but amount is below the required total |
under_dispute | Order has an active claim |
An overpaid USDT order has no dedicated status: it ends as
completedwith the excess inpendingAmount. See Handle Overpaid Orders.