Revamp of Mambu APIs
  • 09 Feb 2024
  • 2 Minutes To Read
  • Dark
    Light
  • PDF

Revamp of Mambu APIs

  • Dark
    Light
  • PDF

Article Summary

Transitioning to API v2

In comparison to Mambu API v1, this change will deliver more streamlined and efficient integrations between your systems and the Mambu Cloud Platform including:

  • 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.

Mambu will take a phased approach in decommissioning the v1 of APIs, divided into three stages. This will allow us to ensure a smooth transition of your operations through an iterative migration approach.

  • Phase 1: Planned for H1 2024 In this phase, we will target endpoints that exist in both Mambu API v1 and v2 with 1-to-1 mirroring of functionality. By 30th of April 2024 we will stop supporting endpoints in scope of phase 1.

Please see below the actions you need to take to avoid receiving the following error message:

500
    “returnCode”: 3,
“returnStatus”: “INVALID_API_OPERATION”
  • Phase 2: We will target endpoints for which the functionality in Mambu API v2 was redesigned. More details on timeline and composition to follow.

  • Phase 3: We will target endpoints that do not yet have a corresponding endpoint in Mambu API v2. More details on timeline and composition to follow.

API v1 endpoints we will stop supporting as of April 30, 2024

Mambu API v1 endpoint Base URL https://TENANT_NAME.mambu.com/apiCorrespondent 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 /branchesGET /branches
GET /branches/{branchId}GET /branches/{branchId}
GET /centresGET /centres
GET /centres/{centreId}GET /centres/{centreId}
GET /clientsGET /clients
GET /clients/{clientId}GET /clients/{clientId}
GET /customfields/{customFieldId}GET /customfields/{customFieldId}
GET /customfieldsetsGET /customfieldsets
GET /documents/{documentId}GET /documents/{documentId}
GET /glaccounts/{glAccountId}GET /glaccounts/{glAccountId}
GET /gljournalentriesGET /gljournalentries
GET /groupsGET /groups
GET /groups/{groupId}GET /groups/{groupId}
GET /loanproductsGET /loanproducts
GET /loanproducts/{loanProductId}GET /loanproducts/{loanProductId}
GET /loansGET /loans
GET /loans/{loanAccountId}GET /loans/{loanAccountId}
GET /loans/{loanAccountId}/templates/{templateId}GET /loans/{loanAccountId}/templates/{templateId}
GET /tasksGET /tasks
GET /userrolesGET /userroles
GET /usersGET /users
GET /users/{userId}GET /users/{userId}
PATCH /clients/{clientId}PATCH /clients/{clientId}
PATCH /loans/{loanAccountId}PATCH /loans/{loanAccountId}
POST /clientsPOST /clients
POST /clients/{clientId}/documentsPOST /clients/{clientId}/documents
POST /database/backupPOST /database/backup
POST /documentsPOST /documents
POST /groupsPOST /groups
POST /indexratesources/{indexRateSourceId}/indexratesPOST /indexratesources/{indexRateSourceId}/indexrates
POST /loansPOST /loans
POST /usersPOST /users
PATCH /linesofcredit/{lineOfCreditId}PATCH /creditarrangements/{creditArrangementId}
GET /linesofcredit/{lineOfCreditId}/accountsGET /creditarrangements/{creditArrangementId}/accounts
PATCH /linesofcredit/{lineOfCreditId}/custominformationPATCH /creditarrangements/{creditArrangementId}
DELETE /linesofcredit/{lineOfCreditId}/custominformation/{customFieldId}PATCH /creditarrangements/{creditArrangementId}
GET /linesofcreditGET /creditarrangements
GET /currenciesGET /currencies
GET /currencies/{currencyCode}GET /currencies/{currencyCode}
GET /transactionchannelsGET /organization/transactionChannels
GET /settings/organizationGET /setup/organization
DELETE/savings/{savingsAccountId}DELETE/deposits/{depositAccountId}
POST /groups/searchPOST /groups:search
POST /clients/searchPOST /clients:search
POST /notifications/messages/searchPOST /communications/messages:search
POST /savings/searchPOST /deposits:search
POST /savings/transactions/searchPOST /deposits/transactions:search
POST /loans/searchPOST /loans:search
POST /loans/transactions/searchPOST /loans/transactions:search
POST /linesofcredit/searchPOST /creditarrangements:search
POST /gljournalentries/searchPOST /gljournalentries:search

Was this article helpful?