Changelog

Este changelog cubre cambios públicos en la API. Cambios menores aditivos (nuevos campos opcionales en responses, nuevos query params opcionales) no se versionan ni se anuncian aquí; solo cambios visibles y posiblemente disruptivos.

Versión inicial

Versión inicial de la API pública de Max Pay.

Recursos disponibles

• POST /v1/auth/login, GET /v1/me
• GET/POST/PUT /v1/clients, GET /v1/clients/{id}
• GET/POST/PUT/DELETE /v1/associates, POST /v1/associates/{id}/activations
• GET/POST/PUT/DELETE /v1/receivable-accounts, POST /v1/receivable-accounts/{id}/activations
• POST /v1/receivable-accounts/{id}/operator-changes
• POST /v1/receivable-accounts/batches
• GET /v1/receivable-accounts/{id}/movements
• GET /v1/receivable-accounts/{id}/receivables
• GET /v1/current-accounts, GET /v1/current-accounts/{id}, GET /v1/current-accounts/{id}/balances, GET /v1/current-accounts/{id}/movements
• GET/POST /v1/transfers, GET /v1/transfers/{id}, POST /v1/transfers/{id}/cancellations
• GET/POST/PUT/DELETE /v1/contacts
• GET/POST/PUT/DELETE /v1/receivables, PATCH /v1/receivables/{id}/status
• POST /v1/receivables/batches
• GET /v1/settlements, GET /v1/settlements/{id}, GET /v1/settlements/{id}/items
• GET/POST /v1/route-settlements, GET /v1/route-settlements/{routeCode}
• GET/POST/PUT/DELETE /v1/webhooks, POST /v1/webhooks/{id}/secret-rotations, POST /v1/webhooks/{id}/deliveries
• GET /v1/batches/{id}
• POST /v1/reports/movements, POST /v1/reports/settlements (asíncronos)

Decisiones de diseño explícitas

• Errores siguen Problem JSON RFC 7807.
• Paginación 1-indexed (page/count) con X-Total-Count header.
• Sin envelope: listados devuelven arrays directamente.
• Sub-recursos en lugar de verbos en URI (ej. POST /receivable-accounts/{id}/activations en lugar de POST /receivable-accounts/{id}:activate).
• Idempotency-Key obligatorio en POST /receivable-accounts y POST /receivables, recomendado en el resto.
• taxId siempre 11 dígitos sin guiones.
• disabled boolean del backend se expone como status enum (ACTIVE/DISABLED).