Mambu

https://docs.mambu.com
Admin
Mambu is a cloud-based composable banking platform that provides lending and deposit products,...
Tokens:3,681,363
Snippets:21,001
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Curl request to get all installments

Source: https://docs.mambu.com/api/api-v2/installments/get-all

Example curl command to retrieve all installments from the Mambu API. It uses the Accept header application/vnd.mambu.v2+json.

```curl
curl -L 'https://api.mambu.com/api/installments' \
-H 'Accept: application/vnd.mambu.v2+json'
```

--------------------------------

### Create Product Settings - Request Body Example

Source: https://docs.mambu.com/api/api-v2/profitsharing_product_settings/create-product-settings

JSON request body for creating product settings. Includes fields for profit calculation method, balance eligibility, payment points, and profit configuration.

```json
{
  "accruedProfitAmountCalculationMethod": "CUSTOMER_PROFIT_RATE_AFTER_ADJUSTMENT",
  "balanceEligibility": {
    "minimumEligible": 0
  },
  "dayOfMonth": 0,
  "effectiveDate": "1987-04-26",
  "poolId": 0,
  "productEncodedKey": "string",
  "productPaymentPoint": "MONTHLY",
  "profit": {
    "cappedRatePercentage": 0,
    "fixedRatePercentage": 0,
    "fixedRateRule": "ALWAYS_USE_FIXED_RATE",
    "tiers": [
      {
        "fromValue": 0,
        "percentage": 0,
        "productSettingsId": 0
      }
    ]
  },
  "profitAccrualPoint": "NEXT_ACCRUAL_DATE",
  "profitApplicationPoint": "PAYMENT_CYCLE_END_DATE",
  "weightage": 0,
  "withholdingTaxSourceKey": "string"
}
```

--------------------------------

### Example request body for creating product settings

Source: https://docs.mambu.com/api/api-v2/profitsharing_product_settings/create-product-settings

Example JSON body for the POST request. It includes all required fields and demonstrates the structure for profit configuration, balance eligibility, and tiers.

```json
{  

  "accruedProfitAmountCalculationMethod": "CUSTOMER_PROFIT_RATE_AFTER_ADJUSTMENT",  

  "balanceEligibility": {  

    "minimumEligible": 0  

  },  

  "creationDate": "2016-09-06T13:37:50+03:00",  

  "dayOfMonth": 0,  

  "effectiveDate": "1987-04-26",  

  "id": 0,  

  "lastModifiedDate": "2016-09-06T13:37:50+03:00",  

  "poolId": 0,  

  "productEncodedKey": "string",  

  "productPaymentPoint": "MONTHLY",  

  "profit": {  

    "cappedRatePercentage": 0,  

    "fixedRatePercentage": 0,  

    "fixedRateRule": "ALWAYS_USE_FIXED_RATE",  

    "tiers": [  

      {  

        "creationDate": "2016-09-06T13:37:50+03:00",  

        "fromValue": 0,  

        "id": 0,  

        "lastModifiedDate": "2016-09-06T13:37:50+03:00",  

        "percentage": 0,  

        "productSettingsId": 0  

      }  

    ]  

  },  

  "profitAccrualPoint": "NEXT_ACCRUAL_DATE",  

  "profitApplicationPoint": "PAYMENT_CYCLE_END_DATE",  

  "weightage": 0,  

  "withholdingTaxSourceKey": "string"  

}
```

--------------------------------

### GET /setup/general

Source: https://docs.mambu.com/api/api-v2/setup_general/get-general-setup

This endpoint retrieves general setup information from the Mambu API. It is a GET request to the /setup/general endpoint. The documentation includes an example of an error response with error details.

```APIDOC
## [GET] /setup/general

### Description
Retrieves general setup information from the Mambu API. This endpoint is used to fetch general configuration settings.

### Method
GET

### Endpoint
https://api.mambu.com/api/setup/general

### Parameters
No parameters are documented for this endpoint.

### Request Example
```
curl -L 'https://api.mambu.com/api/setup/general' \
  -H 'Accept: application/vnd.mambu.v2+json'
```

### Response
#### Success Response (200)
The response schema is not documented in the source. However, the source includes an example of an error response.

#### Error Response
- **errors** (array of objects) - A list of errors that occurred during the request.
  - **errorCode** (int32) - Domain-specific numeric error code that uniquely identifies this failure across all modules. Use this together with `errorReason` to programmatically branch on failure type. Example: `10002`
  - **errorReason** (string) - For more information on your error message, refer to API Response and Error Codes. Example: `INVALID_PARAMETERS`
  - **errorSource** (string) - JSON pointer, field name, or rule identifier that locates the cause of the error in the request, so clients can highlight the offending input back to end users. Example: `filterCriteria[0].field`

#### Error Response Example
```
{
  "errors": [
    {
      "errorCode": 400,
      "errorReason": "INVALID_PARAMETERS",
      "errorSource": "filterCriteria[0].field"
    }
  ]
}
```
```

--------------------------------

### Success Response Example with Links

Source: https://docs.mambu.com/api/api-v2/loans/create

Example response showing the links to the created loan, group, and client.

```json
{
  "Example_UserLink_Field": "8a19cda5778bea6c01778c17fdff027c",
  "Example_GroupLink_Field": "8a19d63c84a36c7f0184a4f33ba85235",
  "Example_ClientLink_Field": "8a19cdac84a3a6c01778a4f33baf027c"
}
```

--------------------------------

### GET 5 savings accounts starting with the 24th resulted entry

Source: https://docs.mambu.com/docs/data-dictionary-and-api-standards

Use this GET request to retrieve a paginated list of savings accounts. The example uses offset=24 and limit=5 to fetch items 25-29.

```http
GET /api/savings?branchId=2&limit=5&offset=24
```

--------------------------------

### YAML configuration body example

Source: https://docs.mambu.com/docs/loan-products-configuration

Example YAML body for a loan product configuration. Shows settings for loan amount, schedule, payment, grace period, new account, and interest.

```yaml
---
id: "6354"
name: "house_mortgage"
notes: "loan product secured by a property that the loan applicant already owns"
type: "DYNAMIC_TERM_LOAN"
category: "COMMERCIAL"
state: "INACTIVE"
loanAmountSettings:
  loanAmount:
    minValue: 1
    maxValue: 100
    defaultValue: 10
  trancheSettings:
    maxNumberOfTranches: 1
scheduleSettings:
  repaymentScheduleMethod: "FIXED"
  scheduleDueDatesMethod: "FIXED_DAYS_OF_MONTH"
  defaultRepaymentPeriodCount: 4
  repaymentPeriodUnit: "MONTHS"
  fixedDaysOfMonth:
  - 2
  - 4
  shortMonthHandlingMethod: "LAST_DAY_IN_MONTH"
  roundingSettings:
    roundingRepaymentScheduleMethod: "NO_ROUNDING"
    repaymentCurrencyRounding: "ROUND_TO_NEAREST_WHOLE_UNIT"
    repaymentElementsRoundingMethod: "ROUND_ALL"
  numInstallments:
    defaultValue: 77
    maxValue: 7
  firstRepaymentDueDateOffset:
    defaultValue: 77
    maxValue: 7
  repaymentScheduleEditOptions:
  - "ADJUST_NUMBER_OF_INSTALLMENTS"
  - "ADJUST_FEE_PAYMENT_SCHEDULE"
  repaymentReschedulingMethod: "NEXT_WORKING_DAY"
  billingCycles:
    enabled: true
    startDays:
    - 9
    - 5
    - 7
  previewSchedule:
    previewScheduleEnabled: true
    numberOfPreviewedInstalments: 3
paymentSettings:
  paymentMethod: "VERTICAL"
  amortizationMethod: "OPTIMIZED_PAYMENTS"
  prepaymentSettings:
    prepaymentRecalculationMethod: "RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS"
    elementsRecalculationMethod: "PRINCIPAL_EXPECTED_FIXED"
    prepaymentAcceptance: "ACCEPT_PREPAYMENTS"
    futurePaymentsAcceptance: "ACCEPT_FUTURE_PAYMENTS"
    applyInterestOnPrepaymentMethod: "AUTOMATIC"
    principalPaidInstallmentStatus: "PARTIALLY_PAID"
  latePaymentsRecalculationMethod: "LAST_INSTALLMENT_INCREASE"
  repaymentAllocationOrder:
  - "FEE"
  - "PRINCIPAL"
  principalPaymentSettings:
    amount:
      minValue: 1
      maxValue: 100
      defaultValue: 10
    percentage:
      minValue: 1
      maxValue: 100
      defaultValue: 10
    principalPaymentMethod: "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    totalDuePayment: "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    defaultPrincipalRepaymentInterval: 6
    principalCeilingValue: 5
    principalFloorValue: 3
    totalDueAmountFloor: 2
    includeFeesInFloorAmount: true
gracePeriodSettings:
  gracePeriod:
    defaultValue: 77
    maxValue: 7
  gracePeriodType: "NONE"
newAccountSettings:
  idGeneratorType: "RANDOM_PATTERN"
  idPattern: "@@@###"
  accountInitialState: "PENDING_APPROVAL"
interestSettings:
  interestApplicationMethod: "REPAYMENT_DUE_DATE"
  interestBalanceCalculationMethod: "PRINCIPAL_AND_INTEREST"
  interestCalculationMethod: "DECLINING_BALANCE"
  daysInYear: "ACTUAL_ACTUAL_ISDA"
  scheduleInterestDaysCountMethod: "REPAYMENT_PERIODICITY"
  interestType: "SIMPLE_INTEREST"
  indexRateSettings:
    indexSourceId: "index source id"
    interestRate:
      minValue: 1
      maxValue: 100
      defaultValue: 10
    interestRateSource: "FIXED_INTEREST_RATE"
    interestRateTerms: "TIERED"
    interestChargeFrequency: "EVERY_DAY"
    interestRateReviewUnit: "MONTHS"
    interestRateReviewCount: 6
    interestChargeFrequencyCount: 9
    accrueInterestAfterMaturity: true
    interestRateCeilingValue: 34
    interestRateFloorValue: 12
    allowNegativeInterestRate: true
    interestRateTiers:
    - endingBalance: 17
      interestRate: 45
    - endingBalance: 17
      interestRate: 45
  accrueLateInterest: true
  compoundingFrequency: "DAILY"
```

--------------------------------

### Sample response for GET with startDate

Source: https://docs.mambu.com/docs/configuration-as-code-for-currencies

Example YAML response for a query with startDate of 2019-01-02. Note that returned accounting and exchange rates have a start date before the query start date, showing the rate in effect at that time.

```yaml
---
startDate: "2019-01-02"
baseCurrency:
  code: "USD"
  name : "US Dollars"
  symbol: "$"
  symbolPosition: "BEFORE_NUMBER"
  digitsAfterDecimal: 2
  type: "FIAT_CURRENCY"
foreignCurrencies:
  - currency:
      code: "EUR"
      name: "Euro"
      symbol: "€"
      symbolPosition: "AFTER_NUMBER"
      digitsAfterDecimal: 2
      type: "FIAT_CURRENCY"
    accountingRates:
      - startDate: "2018-01-02T00:00+11:00"
        rate: 100
      - startDate: "2020-01-02T00:00+11:00"
        rate: 100
    exchangeRates:
      - startDate: "2018-01-02T00:00+11:00"
        buyRate: 100
        sellRate: 110
      - startDate: "2020-01-02T00:00+11:00"
        buyRate: 200
        sellRate: 210
```

--------------------------------

### GET /users (Basic Authentication Example)

Source: https://docs.mambu.com/llms-full.txt

Example of a GET request to the /users endpoint using Basic authentication with curl.

```APIDOC
## GET /users

### Description
Retrieves a resource or a collection of resources. This example shows how to authenticate using Basic authentication.

### Method
GET

### Endpoint
https://TENANT_NAME.mambu.com/api/users

### Authentication
Basic Authentication: Provide an `Authorization` header with the value `Basic <base64-encoded-string>`, where the base64-encoded string is the username and password separated by a colon (e.g., `SomeUser:OpenSesame`).

### Request Example
```shell
curl --location --request GET 'https://TENANT_NAME.mambu.com/api/users' \
--header 'Authorization: Basic U29tZVVzZXI6T3BlblNlc2FtZQ=='
```

### Response
#### Success Response
A JSON object or array representing the resource or collection of resources.

#### Response Example
```json
{
  "field": "value"
}
```

```

--------------------------------

### Example centre configuration YAML

Source: https://docs.mambu.com/docs/configuration-as-code-for-centres

Sample YAML configuration for centres, including two centres with address and custom field value sets. Shows grouped and non-grouped custom fields.

```yaml
centres:
  - id: "DT1"
    name: "Down Town"
    assignedBranchId: "B1"
    state: "ACTIVE"
    meetingDay: "FRIDAY"
    notes: "All clients and officers gather in the market"
    address:
      line1: "line1"
      line2: "line2"
      city: "City"
      region: "Region"
      postcode: "789456"
      country: "Country"
  - id: "MP1"
    name: "Market Place"
    assignedBranchId: "B1"
    state: "ACTIVE"
    meetingDay: "FRIDAY"
    notes: "All clients and officers gather in the market"
    address:
      line1: "line1"
      line2: "line2"
      city: "City"
      region: "Region"
      postcode: "789456"
      country: "Country"
    customFieldValueSets:
      - id: "_grouped_set_id"
        groupedCustomFieldValues:
          - index: 1
            customFieldValues:
              - customFieldId: "_cf_id_1"
                value: "value_group_1_1"
              - customFieldId: "_cf_id_2"
                value: "value_group_1_2"
              - customFieldId: "_cf_id_3"
                value: "value_group_1_3"
          - index: 2
            customFieldValues:
              - customFieldId: "_cf_id_1a"
                value: "value_group_2_1a"
              - customFieldId: "_cf_id_2a"
                value: "value_group_2_2a"
              - customFieldId: "_cf_id_3a"
                value: "value_group_2_3a"
              - customFieldId: "_cf_id_3b"
                value: "client_id"
      - id: "_non_grouped_set_id"
        standardCustomFieldValues:
          - customFieldId: "_cf_non_grouped_1"
            value: "value_non_grouped_1"
          - customFieldId: "_cf_non_grouped_2"
            value: "value_non_grouped_2"
          - customFieldId: "_cf_non_grouped_3"
            value: "value_non_grouped_3"
```

--------------------------------

### GET /setup/general

Source: https://docs.mambu.com/llms-full.txt

Get general setup.

```APIDOC
## GET /setup/general

### Description
Get general setup.

### Method
GET

### Endpoint
/setup/general
```

--------------------------------

### Deposit products YAML configuration example

Source: https://docs.mambu.com/docs/deposit-products-configuration

Example YAML configuration for deposit products, showing a minimal product (product1) and a product with all fields defined (DSP). Use this as a template when creating or updating deposit product configurations via the API.

```yaml
---
depositProducts:
  - id: "product1"
    name: "A product with only the minimum fields defined"
    type: "FIXED_DEPOSIT"
    category: "UNCATEGORIZED"
    state: "ACTIVE"
    description: "A saving product with a <b>fixed deposit</b> where clients can put\
    \ a certain amount in and lock it to collect interest until maturity 2-5 months\
    \ later"
    newAccountSettings:
      idGeneratorType: "RANDOM_PATTERN"
      idPattern: "@@@@###"
    availabilitySettings:
      forGroups: true
      forIndividuals: true
      branchSettings:
        allBranches: true
        branches:
    currencySettings:
      currencies:
        - "USD"
    interestSettings:
      daysInYear: "E30_360"
      paidIntoAccount: true
  - id: "DSP"
    name: "Product example with all fields defined"
    type: "CURRENT_ACCOUNT"
    category: "UNCATEGORIZED"
    state: "INACTIVE"
    description: "Commonly used savings product"
    newAccountSettings:
      idGeneratorType: "INCREMENTAL_NUMBER"
      idPattern: "2"
    availabilitySettings:
      forGroups: false
      forIndividuals: false
      branchSettings:
        allBranches: true
        branches: [ ]
    currencySettings:
      currencies:
        - "EUR"
        - "RON"
        - "CNY"
    maturitySettings:
      maturityPeriodInterval:
        defaultValue: 5
        minValue: 3
        maxValue: 7
      maturityPeriodUnit: "WEEKS"
    taxSettings:
      withholdingTaxEnabled: false
    creditArrangementSettings:
      requirement: "OPTIONAL"
    internalControlsSettings:
      dormancyPeriodDays: 10
      recommendedDepositAmount: 100
      maxWithdrawalAmount: 120
      openingBalance:
        minValue: 10
        maxValue: 30
        defaultValue: 20
      allowOffset: true
    feeSettings:
      allowArbitraryFees: false
      fees:
        - id: "feeForNewProduct"
          name: "Deposit Made"
          active: true
          amount: 120.9
          amountCalculationMethod: "FLAT"
          trigger: "MANUAL"
          accountingRules: [ ]
    interestSettings:
      daysInYear: "ACTUAL_365_FIXED"
      calculationBalance: "END_OF_DAY"
      paidIntoAccount: true
      collectInterestWhenLocked: true
      maximumBalance: 10003
      interestRateSettings:
        interestRateSource: "FIXED_INTEREST_RATE"
        interestRateTerms: "TIERED"
        interestRateTiers:
          - endingBalance: 500
            interestRate: 10
          - endingBalance: 900
            interestRate: 5
        accrueInterestAfterMaturity: true
    overdraftInterestSettings:
      allowOverdraft: true
      allowTechnicalOverdraft: true
      maxOverdraftLimit: 100
      daysInYear: "ACTUAL_365_FIXED"
      calculationBalance: "END_OF_DAY"
      interestRateSettings:
        allowNegativeInterestRate: false
        interestRateSource: "FIXED_INTEREST_RATE"
        interestRateTerms: "TIERED"
        interestRateTiers:
          - endingBalance: 500
            interestRate: 10
          - endingBalance: 900
            interestRate: 5
    accountingSettings:
      accountingRules:
        - glAccountCode: "11001"
          financialResource: "DEPOSIT_REFERENCE"
        - glAccountCode: "10002"
          financialResource: "SAVINGS_CONTROL"
        - glAccountCode: "11003"
          financialResource: "INTEREST_EXPENSE"
        - glAccountCode: "10004"
          financialResource: "FEE_INCOME"
      accountingMethod: "ACCRUAL"
      interestAccruedAccountingMethod: "END_OF_MONTH"
```

--------------------------------

### Example JSON body for updating product settings

Source: https://docs.mambu.com/api/api-v2/profitsharing_product_settings/update-product-settings

Example request body for updating product settings. Includes all required fields such as accruedProfitAmountCalculationMethod, effectiveDate, productEncodedKey, productPaymentPoint, profitAccrualPoint, and profitApplicationPoint.

```json
{  

  "accruedProfitAmountCalculationMethod": "CUSTOMER_PROFIT_RATE_AFTER_ADJUSTMENT",  

  "balanceEligibility": {  

    "minimumEligible": 0  

  },  

  "creationDate": "2016-09-06T13:37:50+03:00",  

  "dayOfMonth": 0,  

  "effectiveDate": "1987-04-26",  

  "id": 0,  

  "lastModifiedDate": "2016-09-06T13:37:50+03:00",  

  "poolId": 0,  

  "productEncodedKey": "string",  

  "productPaymentPoint": "MONTHLY",  

  "profit": {  

    "cappedRatePercentage": 0,  

    "fixedRatePercentage": 0,  

    "fixedRateRule": "ALWAYS_USE_FIXED_RATE",  

    "tiers": [  

      {  

        "creationDate": "2016-09-06T13:37:50+03:00",  

        "fromValue": 0,  

        "id": 0,  

        "lastModifiedDate": "2016-09-06T13:37:50+03:00",  

        "percentage": 0,  

        "productSettingsId": 0  

      }  

    ]  

  },  

  "profitAccrualPoint": "NEXT_ACCRUAL_DATE",  

  "profitApplicationPoint": "PAYMENT_CYCLE_END_DATE",  

  "weightage": 0,  

  "withholdingTaxSourceKey": "string"  

}  

```

--------------------------------

### GET /installments

Source: https://docs.mambu.com/docs/revamp-of-mambu-apis

Retrieves installments between two dates. This endpoint replaces the v1 GET /repayments and returns all installments, including paid ones.

```APIDOC
## GET /installments

### Description
Retrieves installments between two dates. This endpoint replaces the v1 GET /repayments and returns all installments, including paid ones.

### Method
GET

### Endpoint
/installments

### Parameters
#### Query Parameters
- **fromDate** (string) - Required - The start date for filtering installments.
- **toDate** (string) - Required - The end date for filtering installments.

### Response
#### Success Response (200)
- Returns a list of installments.

#### Response Example

[
  {
    "id": "string",
    "dueDate": "string",
    "amount": 100.0,
    "paid": true
  }
]

```

--------------------------------

### Example request - Start event stream

Source: https://docs.mambu.com/api/streaming/get-subscriptions-subscription-id-events

Example request to start an event stream with stream_limit and stream_timeout parameters. The response is not shown. The request includes Accept, apikey, and X-Flow-Id headers.

```http
GET https://TENANT_NAME.mambu.com/api/v1/subscriptions/0691160a-b519-4595-b85c-a400fc73e96/events?stream_limit=10&stream_timeout=600 HTTP/1.1  

  

Accept: application/json  

apikey: string  

X-Flow-Id: string  

```

--------------------------------

### Request Body Example - Create Subscription

Source: https://docs.mambu.com/api/api-v2/subscriptions/create-or-get-subscription

Example request body for creating a subscription. Includes owningApplication, consumerGroup, and readFrom fields.

```json
{  

  "owningApplication": "reporting-service",  

  "consumerGroup": "deposits-consumer",  

  "readFrom": "END"  
}
```
Tokens:
Raw