API Reference
Available Endpoints
The Gateways API offers the following endpoint groups for integration:
Authentication
| Method | Endpoint | Description |
|---|---|---|
POST | /api/auth/token | Generate JWT access token |
Balance
| Method | Endpoint | Description |
|---|---|---|
GET | /api/balance | Query account balance |
PIX Transactions
| Method | Endpoint | Description |
|---|---|---|
POST | /api/pix/cash-in | Generate PIX charge (Cash-In) |
POST | /api/pix/cash-out | Send PIX payment (Cash-Out) |
POST | /api/pix/cash-out-qrcode | Pay via PIX QR Code |
POST | /api/pix/refund-in/\{id\} | Request payment refund |
GET | /api/pix/transaction/\{id\} | Query transaction status |
GET | /api/transactions | Search account transactions |
GET | /api/pix/transactions/pix-key/\{pixKey\} | List transactions by PIX key |
GET | /api/pix/transactions/pix-key/\{pixKey\}/\{identifier\} | Query transaction by PIX key |
MED (Special Returns)
| Method | Endpoint | Description |
|---|---|---|
GET | /api/med | List MED requests with filters |
Webhooks
| Method | Endpoint | Description |
|---|---|---|
POST | /api/resend-webhook/\{transactionIdentifier\} | Resend webhook |
Webhook URLs and the signing key are configured only in the dashboard (https://<dashboard-host>), under Settings → Webhooks. See Configure Webhooks.
Base URL: https://<api-host>. All endpoints (except token generation) require authentication via Bearer token. Token generation requires mTLS: the client certificate is presented in the TLS handshake.
See the authentication guide for more details.