Overview
What the API solves
This is a treasury and collection logistics API. It is designed for the customer's IT team to integrate its ERP (SAP, Oracle, Tango, Bejerman, custom systems) with Max Pay, automating these flows:
- Commercial structure sync: creation and update of clients and associates.
- Recording debt and its modifications: uploading invoices, credit notes, returns and adjustments to the receivable accounts.
- Operational visibility: balances, movements, settlements and reports.
- Event notification: webhooks that notify the ERP when collections, settlements, adjustments occur.
The API does not yet model all of the customer's transactional operations (for example, DEBIN or operating investment funds). Those capabilities are operated from the web panel for now.
Target audience
An integration engineer working against the customer's ERP. This person:
- Reads technical documentation, not marketing.
- Wants to integrate and go back to their work, not learn the PSP internal model.
- Needs actionable errors, clear idempotency, copy-paste examples.
- Expects push notifications (webhooks), not polling.
How this documentation is organized
| Layer | For what | When to read |
|---|---|---|
| General concepts | Understand the model and the cross-cutting conventions | Before touching any endpoint |
| Resources | Know what endpoints exist per resource and how to invoke them | When integrating each part |
| Webhooks | Configure event reception | When building the async integration |
| Reference | Error catalog, changelog, OpenAPI samples | As a reference manual |
Main resources
Solid lines: mandatory ownership. Dashed lines: optional ownership (see customer operating models).