Revamp of Mambu APIs

Updated On 08 Jul 2025
5 Minutes To Read

Print
Share
Dark
Light
PDF

Article summary

Mambu is transitioning to API v2 to improve integrations with its cloud banking platform, featuring a new idempotency mechanism for reliable data handling, seamless pagination, and enhanced security controls. The transition, initially planned in three phases, has been streamlined: Phases 1 and 2 are now combined and rescheduled for Q2 2025, while Phase 3 is set for 2026. The updated endpoints will provide faster responses and improved functionality. Key dates include the start of the notice period on January 31, 2024, and the final reminder on November 28, 2024. API v1 will be disabled in Sandbox environments on August 4, 2025, and in Production on September 22, 2025. Users must audit their systems for API v1 usage and transition to API v2 endpoints by August 25, 2025, to avoid errors.

Did you find this summary helpful?

Thank you for your feedback

As part of our ongoing commitment to enhancing your experience with our platform, we're transitioning to API v2 to deliver more streamlined and efficient integrations between your systems and the Mambu cloud banking platform. These enhancements include:

Enhancements in design, with the inclusion of an idempotency mechanism to ensure data handling is more consistent and reliable.
Seamless pagination for effortless data retrieval, and more refined details which will add precision to your operations.
An enhanced developer-friendly framework with more mature security controls.

Recap of our previous communication

In January 2024, we informed you about the revamp of our APIs and the transition to API v2. This transition was outlined in three phases:

Phase 1: Targeting endpoints with 1-to-1 mirroring of functionality, scheduled for completion by April 30, 2024.
Phase 2: Focused on endpoints with redesigned functionality in API v2.
Phase 3: Addressing entirely new endpoints.

What is changing?

Phases 1 & 2 are now combined for a streamlined transition and are rescheduled for Q2 2025. Phase 3 is planned for 2026.

Redesigned endpoints originally planned for phase 2 are now included in phase 1. The updated endpoints offer faster responses, new and improved functionality exclusive to API v2, and a streamlined API framework for easier maintenance.

The extension of the first two phases to Q2 2025 offers sufficient time for you to adapt your systems infrastructure and seamlessly migrate to the new endpoints.

Here's the updated timeline, which is subject to change:

31 January 2024: Commencement of the notice period and change notification
16 April 2024: Notification of extended transition timeline and first reminder
18 July 2024: Second reminder
22 October 2024: Third reminder
28 November 2024: Final reminder
August 04: API v1 will be disabled in the Sandbox environments. This marks the start of the official Sandbox testing period for customers.
September 22: API v1 will be disabled in Production.

What actions do you need to take?

Complete these actions to avoid receiving the error message below:

Conduct an audit of your systems architecture to identify any use of API v1 endpoints within the scope of phases 1 and 2 that need to be transitioned.
Transition your integration code from API v1 to equivalent v2 endpoints before August 25 2025.

Failure to do so will result in the following error message:

500
    “returnCode”: 3,
“returnStatus”: “INVALID_API_OPERATION”

API v1 endpoints we will stop supporting in production as of September 2025

Mambu API v1 endpoint Base URL https://TENANT_NAME.mambu.com/api	Correspondent Mambu API v2 endpoint Base URL https://TENANT_NAME.mambu.com/api
`DELETE /documents/{documentId}`	`DELETE /documents/{documentId}`
`DELETE /documents/{documentId}`	`DELETE /documents/{documentId}`
`DELETE /loans/{loanAccountId}`	`DELETE /loans/{loanAccountId}`
`GET /branches`	`GET /branches`
`GET /branches/{branchId}`	`GET /branches/{branchId}`
`GET /centres`	`GET /centres`
`GET /centres/{centreId}`	`GET /centres/{centreId}`
`GET /clients`	`GET /clients`
`GET /clients/{clientId}`	`GET /clients/{clientId}`
`GET /customfields/{customFieldId}`	`GET /customfields/{customFieldId}`
`GET /customfieldsets`	`GET /customfieldsets`
`GET /documents/{documentId}`	`GET /documents/{documentId}`
`GET /groups`	`GET /groups`
`GET /groups/{groupId}`	`GET /groups/{groupId}`
`GET /loans`	`GET /loans`
`GET /loans/{loanAccountId}`	`GET /loans/{loanAccountId}`
`GET /loans/{loanAccountId}/templates/{templateId}`	`GET /loans/{loanAccountId}/templates/{templateId}`
`GET /tasks`	`GET /tasks`
`GET /userroles`	`GET /userroles`
`GET /users`	`GET /users`
`GET /users/{userId}`	`GET /users/{userId}`
`PATCH /clients/{clientId}`	`PATCH /clients/{clientId}`
`POST /clients`	`POST /clients`
`POST /clients/{clientId}/documents`	`POST /clients/{clientId}/documents`
`POST /database/backup`	`POST /database/backup`
`POST /documents`	`POST /documents`
`POST /groups`	`POST /groups`
`POST /indexratesources/{indexRateSourceId}/indexrates`	`POST /indexratesources/{indexRateSourceId}/indexrates`
`POST /loans`	`POST /loans`
`POST /users`	`POST /users`
`PATCH /linesofcredit/{lineOfCreditId}`	`PATCH /creditarrangements/{creditArrangementId}`
`GET /linesofcredit/{lineOfCreditId}/accounts`	`GET /creditarrangements/{creditArrangementId}/accounts`
`PATCH /linesofcredit/{lineOfCreditId}/custominformation`	`PATCH /creditarrangements/{creditArrangementId}`
`DELETE /linesofcredit/{lineOfCreditId}/custominformation/{customFieldId}`	`PATCH /creditarrangements/{creditArrangementId}`
`GET /linesofcredit`	`GET /creditarrangements`
`GET /currencies`	`GET /currencies`
`GET /currencies/{currencyCode}`	`GET /currencies/{currencyCode}`
`GET /transactionchannels`	`GET /organization/transactionChannels`
`GET /settings/organization`	`GET /setup/organization`
`DELETE/savings/{savingsAccountId}`	`DELETE/deposits/{depositAccountId}`
`POST /groups/search`	`POST /groups:search`
`POST /clients/search`	`POST /clients:search`
`POST /notifications/messages/search`	`POST /communications/messages:search`
`POST /savings/search`	`POST /deposits:search`
`POST /loans/search`	`POST /loans:search`
`POST /loans/transactions/search`	`POST /loans/transactions:search`
`POST /linesofcredit/search`	`POST /creditarrangements:search`

New endpoints added to phase 1

Mambu API v1 endpoint Base URL https://TENANT_NAME.mambu.com/api	Correspondent Mambu API v2 endpoint Base URL https://TENANT_NAME.mambu.com/api
`GET /savings/{savingsAccountId}/comments`	`GET /comments?{ownerType&ownerKey}`
`POST/savings/{savingsAccountId}/comments`	`POST /comments`, expects a JSON payload in the form `{"ownerKey": "{ownerKey}", "ownerType": "{ownerType}", "text": "string text"}`
`DELETE /branches/{branchId}/documents/{documentId}`	`DELETE /documents/{documentId}`, API returns 204 (No content) for successful deletion, as opposed to 200 returned by V1.
`DELETE /centres/{centreId}/documents/{documentId}`	`DELETE /documents/{documentId}`, API returns 204 (No content) for successful deletion, as opposed to 200 returned by V1.
`DELETE /clients/{clientId}/documents/{documentId}`	`DELETE /documents/{documentId}`, API returns 204 (No content) for successful deletion, as opposed to 200 returned by V1.
`DELETE /documents/{documentId}`	`DELETE /documents/{documentId}`, API returns 204 (No content) for successful deletion, as opposed to 200 returned by V1.
`DELETE /groups/{groupId}/documents/{documentId}`	`DELETE /documents/{documentId}`, API returns 204 (No content) for successful deletion, as opposed to 200 returned by V1.
`DELETE /loanproducts/{loanProductId}/documents/{documentId}`	`PATCH /loanproducts/{loanProductId}`
`DELETE /loans/{loanAccountId}/documents/{documentId}`	`DELETE /documents/{documentId}`
`DELETE /savings/{savingsAccountId}/documents/{documentId}`	`DELETE /documents/{documentId}`
`DELETE /savingsproducts/{savingsProductId}/documents/{documentId}`	`DELETE /documents/{documentId}`
`DELETE /users/{userId}/documents/{documentId}`	`DELETE /documents/{documentId}`
`GET /branches/{branchId}/documents`	`GET /documents/documentsMetadata` + `GET /documents/{documentId}`, V2 metadata endpoint expects entity type as required query parameter. In this case, entity=BRANCH
`GET /branches/{branchId}/documents/{documentId}`	`GET /documents/{documentId}`
`GET /centres/{centreId}/documents`	`GET /documents/documentsMetadata` + `GET /documents/{documentId}`, V2 metadata endpoint expects entity type as required query parameter. In this case, entity=CENTRE
`GET /centres/{centreId}/documents/{documentId}`	`GET /documents/{documentId}`
`GET /clients/{clientId}/loans/{loanAccountId}`	`GET /loans` and specify account holder id
`GET /clients/{clientId}/linesofcredit`	`GET /clients/{clientId}/creditarrangements`
`GET /clients/{clientId}/documents`	`GET /clients/{clientId}/documentsMetadata` + `GET /documents/{documentId}`, V2 metadata endpoint expects entity type as required query parameter. In this case, entity=CLIENT
`GET /clients/{clientId}/documents/{documentId}`	`GET /clients/documents/{documentId}`
`GET /documents`	`GET /documents/documentsMetadata` + `GET /documents/{documentId}`
`GET /documents/{documentId}`	`GET /documents/{documentId}`
`GET /groups/{groupId}/documents`	`GET /documents/documentsMetadata` + `GET /documents/{documentId}`, V2 metadata endpoint expects entity type as required query parameter. In this case, entity=GROUP
`GET /groups/{groupId}/documents/{documentId}`	`GET /documents/{documentId}`
`GET /groups/{groupId}/linesofcredit`	`GET /groups/{groupId}/creditarrangements`
`GET /loanproducts/{loanProductId}/documents`	`GET /documents/documentsMetadata`
`GET /loanproducts/{loanProductId}/documents/{documentId}`	`GET /documents/{documentId}`
`GET /loanproducts/{loanProductId}/schedule`	`POST /loans/schedule:preview`
`GET /loans/{loanAccountId}/documents`	`GET /documents/documentsMetadata`
`GET /loans/{loanAccountId}/documents/{documentId}`	`GET /documents/{documentId}`
`GET /repayments`	`GET /installments` (returns all installments between two dates compared with api v1 that excludes the paid installments)
`GET /loans/{loanAccountId}/transactions`	`GET /loans/{loanAccountId}/transactions`
`GET /linesofcredit/{lineOfCreditId}`	`GET /creditarrangements/{creditArrangementId}`
`GET /linesofcredit/{lineOfCreditId}/custominformation/{customFieldId}`	`GET /creditarrangements/{creditArrangementId}` with full details
`GET /users/{userId}/documents`	`GET /documents/documentsMetadata` + `GET /documents/{documentId}`
`POST /branches/{branchId}/documents`	`POST /documents`
`GET /users/{userId}/documents/{documentId}`	`GET /documents/{documentId}`
`POST /centres/{centreId}/documents`	`POST /documents`
`POST /documents`	`POST /documents`
`POST /groups/{groupId}/documents`	`POST /documents`
`POST /loanproducts/{loanProductId}/documents`	`POST /documents`
`POST /loans/{loanAccountId}/documents`	`POST /documents`
`POST /savings/{savingsAccountId}/documents`	`POST /documents`
`POST /savingsproducts/{savingsProductId}/documents`	`POST /documents`
`POST /users/{userId}/documents`	`POST /documents`
`GET /branches/{branchId}/comments`	`GET /comments`, Expects `ownerType` and `ownerKey` as required parameters (i.e. `BRANCH` + branch encoded key)
`GET /centres/{centreId}/comments`	`GET /comments`, Expects `ownerType` and `ownerKey` as required parameters (i.e. `CENTRE` + centre encoded key)
`GET /clients/{clientId}/comments`	`GET /comments`, Expects `ownerType` and `ownerKey` as required parameters (i.e. `CLIENT` + client encoded key)
`GET /groups/{groupId}/comments`	`GET /comments`, Expects `ownerType` and `ownerKey` as required parameters (i.e. `GROUP` + group encoded key)
`GET /loanproducts/{loanProductId}/comments`	`GET /comments` and filter for loan product
`GET /loans/{loanAccountId}/comments`	`GET /comments` and filter for loan account
`GET /loans/{loanAccountId}/custominformation/{customFieldId}`	`GET /loans/{loanAccountId}` with details level full
`GET /savingsproducts/{savingsProductId}/comments`	`GET /comments`, Expects `ownerType` and `ownerKey` as required parameters (i.e. `SAVINGS_PRODUCT` + savings product encoded key)
`GET /users/{userId}/comments`	`GET /comments`, Expects `ownerType` and `ownerKey` as required parameters (i.e. `USER` + user encoded key)
`POST /branches/{branchId}/comments`	`POST /comments`
`POST /centres/{centreId}/comments`	`POST /comments`
`POST /clients/{clientId}/comments`	`POST /comments`
`POST /groups/{groupId}/comments`	`POST /comments`
`POST /loanproducts/{loanProductId}/comments`	`POST /comments`
`POST /loans/{loanAccountId}/comments`	`POST /comments`
`POST /savingsproducts/{savingsProductId}/comments`	`POST /comments`
`POST /users/{userId}/comments`	`POST /comments`
`POST /linesofcredit`	`POST /creditarrangements`
`POST /linesofcredit/{lineOfCreditId}/loans/{loanAccountId}`	`POST /creditarrangements/{creditArrangementId}:addAccount`

Was this article helpful?

What's Next

Mambu Release Cycle

On this page

Recap of our previous communication
What is changing?
What actions do you need to take?
API v1 endpoints we will stop supporting in production as of September 2025
New endpoints added to phase 1