Referência da API
A API Forge oferece os seguintes grupos de endpoints para integração:
| Método | Endpoint | Descrição |
|---|
POST | /api/auth/token | Gerar token de acesso JWT |
| Método | Endpoint | Descrição |
|---|
GET | /api/balance | Consultar saldo da conta |
| 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 |
| Método | Endpoint | Descrição |
|---|
GET | /api/webhooks | Listar webhooks configurados |
POST | /api/webhooks | Configurar webhook |
POST | /api/resend-webhook/\{transactionIdentifier\} | Reenviar webhook |
Todos os endpoints (exceto geração de token) requerem autenticação via Bearer token.
Consulte o guia de autenticação para mais detalhes.
