Sistema REST para gestión de corresponsales bancarios. Permite consultar facturas, notificar pagos y reversar transacciones mediante stored procedures en bases de datos SQL Server multi-tenant.

¿Qué puedes hacer?

• Consultar facturas — Obtén el estado y detalle de una factura: POST /corresponsales/api/factura/consulta/
• Notificar un pago — Registra el pago de una factura consultada: POST /corresponsales/api/factura/pago/
• Reversar un pago — Cancela una notificación de pago: POST /corresponsales/api/factura/pago/reversar/

Inicio rápido

1. Obtén credenciales — Tu equipo de operaciones te entregará usuario, contraseña y api-key
2. Lee la autenticación — JWT + api-key son obligatorios en cada request
3. Prueba en sandbox — Usa el ambiente de pruebas antes de producción
4. Integra el flujo completo — Consulta → Pago → (Reversa opcional)

Flujo de integración

Todo pago requiere una consulta previa. El request_id devuelto por la consulta es el vínculo entre las tres operaciones.

1. Obtener JWT
   POST /api/token/
   Body: { "username": "...", "password": "..." }
   Response: { "access": "eyJ...", "refresh": "eyJ..." }

2. Consultar factura
   POST /corresponsales/api/factura/consulta/
   Headers: Authorization: Bearer {token}
            api-key: {tu-api-key}
   Body: { "invoice_id": "2025407608" }
   Response: {
     "status": "0",
     "message": "Consulta exitosa",
     "data": {
       "ReciboPago": "2025407608",
       "Total": 1003973,
       "Vencimiento": "2026-02-09",
       "Pagado": false,
       "Vencido": false,
       "Usable": true
     },
     "request_id": "f7002954-8ec2-4248-9c8e-6625a2588117"
   }

3. Notificar pago  (solo si Usable = true)
   POST /corresponsales/api/factura/pago/
   Headers: Authorization: Bearer {token}
            api-key: {tu-api-key}
   Body: { "request_id": "f7002954-8ec2-4248-9c8e-6625a2588117" }
   Response: {
     "status": "0",
     "message": "Pago notificado exitosamente",
     "data": { ... },
     "llave_recibo": "..."
   }

4. (Opcional) Reversar el pago
   POST /corresponsales/api/factura/pago/reversar/
   Headers: Authorization: Bearer {token}
            api-key: {tu-api-key}
   Body: { ... }   ← parámetros definidos por el SP configurado
   Response: { "status": "0", "message": "Pago revertido exitosamente", "data": [...] }
          

Precondiciones de negocio

• Solo se pueden pagar facturas con "Usable": true
• El request_id del pago debe corresponder a una consulta previa exitosa ("status": "0") del mismo usuario
• El JWT y el api-key deben pertenecer al mismo usuario API
• El usuario debe tener permiso explícito en cada endpoint (User_Endpoint)

Seguridad

• JWT Bearer Token — Obligatorio en Authorization: Bearer {token}. Vigencia: 8 horas.
• api-key — UUID único por usuario API. Obligatorio en header api-key. Debe pertenecer al mismo usuario del JWT.
• HTTPS obligatorio — En producción, toda comunicación debe ser cifrada
• Rate limit — 200 requests/hora por usuario autenticado

---

Próximamente: Log de transacciones para implementadores — consulta el historial completo de operaciones por usuario, rango de fechas y estado.

1. Get JWT
   POST /api/token/
   Body: { "username": "...", "password": "..." }
   Response: { "access": "eyJ...", "refresh": "eyJ..." }

2. Query invoice
   POST /corresponsales/api/factura/consulta/
   Headers: Authorization: Bearer {token}
            api-key: {your-api-key}
   Body: { "invoice_id": "2025407608" }
   Response: {
     "status": "0",
     "message": "Consulta exitosa",
     "data": {
       "ReciboPago": "2025407608",
       "Total": 1003973,
       "Vencimiento": "2026-02-09",
       "Pagado": false,
       "Vencido": false,
       "Usable": true
     },
     "request_id": "f7002954-8ec2-4248-9c8e-6625a2588117"
   }

3. Notify payment  (only if Usable = true)
   POST /corresponsales/api/factura/pago/
   Headers: Authorization: Bearer {token}
            api-key: {your-api-key}
   Body: { "request_id": "f7002954-8ec2-4248-9c8e-6625a2588117" }
   Response: {
     "status": "0",
     "message": "Pago notificado exitosamente",
     "data": { ... },
     "llave_recibo": "..."
   }

4. (Optional) Reverse payment
   POST /corresponsales/api/factura/pago/reversar/
   Headers: Authorization: Bearer {token}
            api-key: {your-api-key}
   Body: { ... }   ← parameters defined by the configured SP
   Response: { "status": "0", "message": "Pago revertido exitosamente", "data": [...] }