Developer Center

Savings Products API

Last Updated: Feb 20, 2017 04:35PM CET

URL

/api/savingsproducts 
/api/savingsproducts/{ID}

Description

Allows you to retrieve one individual savings product by id/key or a list of paginated savings products.

Methods

GET Savings Products

Allows retrieving savings products directly by ID/key or through paginating the list of savings products.

Usage examples

//get savings product using id
GET /api/savingsproducts/DSP

//get savings product using encoded key
GET /api/savingsproducts/8a2bbaab4700677d01470095fc5d0492

//get a list of savings products using default pagination
GET /api/savingsproducts

//get a list of savings products using custom pagination
GET /api/savingsproducts?offset=50&limit=100

Samples responses:

//sample response of a savings product fetched by id/key
{
  "encodedKey": "40288afa542e0acb01542e1481850006",
  "id": "WTAO",
  "name": "With Tiers And Overdraft",
  "creationDate": "2016-04-18T08:27:39+0300",
  "lastModifiedDate": "2016-04-19T10:32:56+0300",
  "forGroups": true,
  "forIndividuals": true,
  "productType": "CURRENT_ACCOUNT",
  "interestPaidIntoAccount": true,
  "interestRateSettings": {
    "encodedKey": "40288afa542e0acb01542e14818e000a",
    "interestChargeFrequency": "ANNUALIZED",
    "interestChargeFrequencyCount": 1,
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED",
    "interestRateTiers": [
      {
        "encodedKey": "40288afa542e0acb01542e14818f000b",
        "index": 0,
        "endingBalance": "100",
        "interestRate": "5"
      },
      {
        "encodedKey": "40288afa542e0acb01542e14818f000c",
        "index": 1,
        "endingBalance": "200",
        "interestRate": "10"
      }
    ]
  },
  "interestCalculationBalance": "AVERAGE",
  "activated": true,
  "interestPaymentPoint": "FIRST_DAY_OF_MONTH",
  "collectInterestWhenLocked": true,
  "minOpeningBalance": "0",
  "overdraftInterestRateSettings": {
    "encodedKey": "40288afa542e0acb01542e1481860007",
    "interestChargeFrequency": "ANNUALIZED",
    "interestChargeFrequencyCount": 1,
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED",
    "interestRateTiers": [
      {
        "encodedKey": "40288afa542e0acb01542e1481880008",
        "index": 0,
        "endingBalance": "50",
        "interestRate": "7"
      },
      {
        "encodedKey": "40288afa542e0acb01542e1481890009",
        "index": 1,
        "endingBalance": "100",
        "interestRate": "10"
      }
    ]
  },
  "overdraftDaysInYear": "ACTUAL_365_FIXED",
  "interestDaysInYear": "ACTUAL_365_FIXED",
  "maxOverdraftLimit": "5000",
  "allowOverdraft": true,
  "maturityPeriodUnit": "MONTHS",
  "description": "",
  "savingsFees": [
    
  ],
  "allowArbitraryFees": false,
  "idGeneratorType": "RANDOM_PATTERN",
  "idPattern": "@@@@###",
  "accountingMethod": "NONE",
  "savingsProductRules": [
    
  ],
  "interestAccruedAccountingMethod": "NONE",
  "withholdingTaxEnabled": false,
  "lineOfCreditRequirement": "OPTIONAL",
  "templates": []
}
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete