Referencia de la API
Endpoints Disponibles
La API de Gateways ofrece los siguientes grupos de endpoints para integración:
Autenticación
| Método | Endpoint | Descripción |
|---|---|---|
POST | /api/auth/token | Generar token de acceso JWT |
Saldo
| Método | Endpoint | Descripción |
|---|---|---|
GET | /api/balance | Consultar saldo de la cuenta |
Transacciones PIX
| Método | Endpoint | Descripción |
|---|---|---|
POST | /api/pix/cash-in | Generar cobro PIX (Cash-In) |
POST | /api/pix/cash-out | Enviar pago PIX (Cash-Out) |
POST | /api/pix/cash-out-qrcode | Pagar mediante código QR PIX |
POST | /api/pix/refund-in/\{id\} | Solicitar reembolso de pago |
GET | /api/pix/transaction/\{id\} | Consultar estado de transacción |
GET | /api/transactions | Buscar transacciones de la cuenta |
GET | /api/pix/transactions/pix-key/\{pixKey\} | Listar transacciones por clave PIX |
GET | /api/pix/transactions/pix-key/\{pixKey\}/\{identifier\} | Consultar transacción por clave PIX |
MED (Devoluciones Especiales)
| Método | Endpoint | Descripción |
|---|---|---|
GET | /api/med | Listar solicitudes MED con filtros |
Webhooks
| Método | Endpoint | Descripción |
|---|---|---|
POST | /api/resend-webhook/\{transactionIdentifier\} | Reenviar webhook |
Las URLs de webhook y la clave de firma se configuran solo en el panel (https://<dashboard-host>), en Configuración → Webhooks. Vea Configurar Webhooks.
Base URL: https://<api-host>. Todos los endpoints (excepto la generación de token) requieren autenticación mediante Bearer token. La generación de token exige mTLS: el certificado de cliente se presenta en el handshake TLS.
Consulte la guía de autenticación para más detalles.