Referência da API
Endpoints Disponíveis
A API Gateways oferece os seguintes grupos de endpoints para integração:
Autenticação
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/auth/token | Gerar token de acesso JWT |
Saldo
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/balance | Consultar saldo da conta |
Transações PIX
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/pix/cash-in | Gerar cobrança PIX (Cash-In) |
POST | /api/pix/cash-out | Realizar pagamento PIX (Cash-Out) |
POST | /api/pix/cash-out-qrcode | Pagar via QR Code PIX |
POST | /api/pix/refund-in/\{id\} | Solicitar estorno de pagamento |
GET | /api/pix/transaction/\{id\} | Consultar status de transação |
GET | /api/transactions | Buscar transações da conta |
GET | /api/pix/transactions/pix-key/\{pixKey\} | Listar transações por chave PIX |
GET | /api/pix/transactions/pix-key/\{pixKey\}/\{identifier\} | Consultar transação por chave PIX |
MED (Devoluções Especiais)
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/med | Listar requisições MED com filtros |
Webhooks
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/resend-webhook/\{transactionIdentifier\} | Reenviar webhook |
O cadastro de URLs de webhook e a chave de assinatura são configurados apenas no painel (https://<dashboard-host>), em Configurações → Webhooks. Veja Configurar Webhooks.
Base URL: https://<api-host>. Todos os endpoints (exceto geração de token) requerem autenticação via Bearer token. A geração de token exige mTLS: o certificado de cliente é apresentado no handshake TLS.
Consulte o guia de autenticação para mais detalhes.