Visión general
Qué resuelve la API
Esta es una API de tesorería y logística de recaudación. Está pensada para que el equipo de IT del customer integre su ERP (SAP, Oracle, Tango, Bejerman, sistemas propios) con Max Pay, automatizando los flujos de:
- Sincronización de estructura comercial: alta y actualización de clientes y asociados.
- Registro de deuda y sus modificaciones: subir facturas, notas de crédito, devoluciones y ajustes a las cuentas recaudadoras.
- Visibilidad operativa: consulta de saldos, movimientos, liquidaciones y reportes.
- Notificación de eventos: webhooks que avisan al ERP cuando ocurren cobros, liquidaciones, ajustes.
La API todavía no modela todas las operaciones transaccionales del customer (por ejemplo, DEBIN u operar fondos de inversión). Esas capacidades se operan desde el panel web por ahora.
Persona objetivo
Un ingeniero de integración trabajando contra el ERP del customer. Esta persona:
- Lee documentación técnica, no marketing.
- Quiere integrar y volver a su trabajo, no aprender el modelo interno del PSP.
- Necesita errores accionables, idempotencia clara, ejemplos copy-paste.
- Espera notificaciones push (webhooks), no polling.
Cómo está organizada esta documentación
| Capa | Para qué | Cuándo leerla |
|---|---|---|
| Conceptos generales | Entender el modelo y las convenciones transversales | Antes de tocar un endpoint |
| Recursos | Saber qué endpoints hay por cada recurso y cómo invocarlos | Al integrar cada parte |
| Webhooks | Configurar la recepción de eventos | Al armar la integración asíncrona |
| Referencia | Catálogo de errores, changelog, samples OpenAPI | Como manual de consulta |
Recursos principales
Líneas continuas: pertenencia obligatoria. Líneas punteadas: pertenencia opcional (ver modelos de operación del customer).