Skip to main content

Changelog

This changelog covers public changes in the API. Minor additive changes (new optional response fields, new optional query params) are not versioned or announced here; only visible and potentially disruptive changes.

Initial version​

Initial release of the Max Pay public API.

Available resources​

  • 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 (asynchronous)

Explicit design decisions​

  • Errors follow Problem JSON RFC 7807.
  • 1-indexed pagination (page/count) with the X-Total-Count header.
  • No envelope: list endpoints return arrays directly.
  • Sub-resources instead of verbs in the URI (e.g. POST /receivable-accounts/{id}/activations instead of POST /receivable-accounts/{id}:activate).
  • Idempotency-Key required on POST /receivable-accounts and POST /receivables, recommended on the rest.
  • taxId is always 11 digits without dashes.
  • The backend's disabled boolean is exposed as a status enum (ACTIVE/DISABLED).