Learn about the main resources of the Mambu Payments (formerly Numeral) API
The Mambu Payments API is a REST API. It has predictable resource-oriented URLs, accepts form request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.
The API is built around the following main resources:
| Resource | Description |
|---|---|
| Connected accounts | A connected account is a bank or technical account connected through Mambu Payments |
| Account holders | An individual or organization you need to send money to or receive money from |
| External accounts | The bank account of a counterparty |
| Internal accounts | The bank account of a customer on behalf of which you send or receive payments |
| Payment orders | A payment order sent to your bank from a connected account |
| Incoming payments | A payment received on a connected account |
| Returns | The return of a payment order or an incoming payment |
| Payment captures | A payment capture is a card or APM charge, refund, or chargeback |
| Transactions | A debit or credit transaction posted on a connected account |
| Balances | A balance posted on a connected account |
| Direct debit mandates | A mandate that authorises a creditor to debit a bank account |
| Reconciliations | A reconciliation between a payment and a transaction |
| Expected payments | A payment expected on a connected account |
| Payee verification requests | A request sent or received to verify a payee as part of EU's VOP regulation |
| Files | A file sent to or received from a partner bank, CSM, or connectivity provider, such as a payment file, a payment status report file, or an account statement file |
| Events | An event created when a payment is updated, a transaction is booked, a balance is created, etc. |
| Return requests | The request to return a payment order or an incoming payment |
| Inquiries | An inquiry related to a return request |
| Claims | A claim related to a payment order or an incoming payment |