Base URL
| Environment | URL |
|---|
| Production | https://api.pixusglobal.com |
| Staging | https://staging.pixusglobal.com |
The Staging environment is currently under maintenance and may be unstable.
Authentication
All routes require a Bearer token in the Authorization header:
Authorization: Bearer <token>
Content Negotiation
| Format | Content-Type | Accept | Description |
|---|
| JSON | application/json | application/json | Default, compatible |
| msgpack | application/msgpack | application/msgpack | Binary, more efficient |
msgpack is recommended for server-to-server integration where performance is a priority.
Available endpoints
Quotes
| Method | Route | Description |
|---|
| GET | /client/quote | Generate a trade quote |
Quotes expire in 5 seconds. The quoteId must be used to create the order before expiration.
Orders
| Method | Route | Description |
|---|
| POST | /client/order | Create a buy order |
| GET | /client/orders | List orders with filters |
| GET | /client/orders/:id | Get order by ID |
| GET | /client/orders/:id/tracking | Track cryptocurrency delivery |
Order statuses
| Status | Description |
|---|
pending | Order created, awaiting payment |
partial | Partial payment received |
paid | Fully paid |
withdrawn | Crypto sent to destination wallet |
settled | Fully settled |
Financial balance
| Method | Route | Description |
|---|
| GET | /client/balance | Get financial summary |
- Fiat balance (BRL) and crypto balance (USDT)
- Credit limit total, used, and available
canWithdraw flag indicating withdrawal eligibility
Webhooks
| Method | Route | Description |
|---|
| POST | /client/webhook/config | Configure webhook |
| GET | /client/webhook/config | Get configuration |
| GET | /client/webhook/:id/logs | Logs for a specific webhook |
| GET | /client/webhook/logs | All webhook logs |
Webhook events
| Event | Description |
|---|
quote | New quote generated |
order | New order created |
deposit_fiat | Fiat deposit (PIX) received |
deposit_crypto | Crypto deposit received |
withdrawal_fiat | Fiat withdrawal (PIX) sent |
withdrawal_crypto | Crypto sent to blockchain |
POST to the configured URL with the event payload:
{
"event": "order",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"amount": 1000,
"symbol": "USDTBRL",
"price": "5.4200",
"side": "BUY",
"timestamp": "2025-01-15T14:30:00.000Z"
}
}
| Parameter | Type | Default | Description |
|---|
limit | number | 20 | Items per page |
offset | number | 1 | Current page |
Common error codes
| Code | Description |
|---|
400 | Invalid parameters or expired quote |
401 | Missing or invalid token |
403 | No permission for the resource |
404 | Resource not found |
500 | Internal server error |
