Developer Center

Loan Products API

Last Updated: Oct 24, 2017 05:20PM CEST

URL

/api/loanproducts
/api/loanproducts/{ID}
/api/loanproducts/{ID}/schedule/

Description

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

Methods

GET Loan Products

Allows retrieving loan products directly using ID/key or through paginating the list of loan products, using the following three calls:
  1. Without parameters, it returns all loan products.
  2. With ID, it returns the information of the specific loan product.
  3. With ID and the /schedule modifier, it returns a preview of the repayments schedule.
Parameter Type Description
anticipatedDisbursement Date Expected disbursement date
firstRepaymentDate Date Due date of the first instalment
loanAmount Number Amount validated against the minimum / maximum constraints. Mandatory
interestRate Number Interest rate in full numbers (e.g. 2.6, not 0.026). Mandatory if no default specified in the product.
repaymentInstallments Number Number of instalments. Mandatory if no default specified in the product.
gracePeriod Number Number of instalments in grace period. Mandatory if no default specified in the product.
repaymentPeriodUnit String Units used for repaymentPeriodCount (DAYS, WEEKS, MONTHS, YEARS). Mandatory if no default specified in the product.
repaymentPeriodCount Number Number of repaymentPeriodUnit's are in a instalment. Mandatory if no default specified in the product.
principalRepaymentInterval Number How many repayments to pay the principal. Mandatory if no default specified in the product.
periodicPayment Number The amount per periodic payment. This is mandatory for ballon payments.

Usage examples

//get loan product using id
GET /api/loanproducts/AGL

//get loan product using encoded key
GET /api/loanproducts/8a2bbaab4700677d01470095fb5f0490

//get a list of loan products using default pagination
GET /api/loanproducts

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

//get a preview of the repayment schedule
GET /api/loanproducts/AGL/schedule?loanAmount=980&firstRepaymentDate=2015-02-27&anticipatedDisbursement=2015-02-01&interestRate=2&repaymentInstallments=6&gracePeriod=0&repaymentPeriodUnit=WEEKS&repaymentPeriodCount=4&principalRepaymentInterval=1

Samples responses:

{
   "encodedKey":"8a6c1f544b5c4853014b5f27174207b4",
   "id":"360",
   "creationDate":"2015-02-06T13:49:32+0000",
   "lastModifiedDate":"2015-11-13T14:26:14+0000",
   "productName":"30 e 360",
   "productDescription":"",
   "loanType":"INDVIDUAL",
   "loanProductType":"DYNAMIC_TERM_LOAN",
   "defaultLoanAmount":"1000",
   "maxNumberOfDisbursementTranches":1,
   "idGeneratorType":"RANDOM_PATTERN",
   "idPattern":"@@@@###",
   "accountInitialState":"PENDING_APPROVAL",
   "activated":true,
   "repaymentScheduleMethod":"DYNAMIC",
   "scheduleDueDatesMethod":"INTERVAL",
   "defaultRepaymentPeriodCount":1,
   "repaymentPeriodUnit":"MONTHS",
   "defaultNumInstallments":12,
   "gracePeriodType":"NONE",
   "defaultPrincipalRepaymentInterval":1,
   "roundingRepaymentScheduleMethod":"ROUND_REMAINDER_INTO_LAST_REPAYMENT",
   "repaymentCurrencyRounding":"NO_ROUNDING",
   "repaymentElementsRoundingMethod":"NO_ROUNDING",
   "paymentMethod":"HORIZONTAL",
   "amortizationMethod":"STANDARD_PAYMENTS",
   "decliningBalancePrepaymentRecalculation":"NO_RECALCULATION",
   "latePaymentsRecalculationMethod":"INCREASE_OVERDUE_INSTALLMENTS",
   "prepaymentAcceptance":"ACCEPT_PREPAYMENTS",
   "futurePaymentsAcceptance":"NO_FUTURE_PAYMENTS",
   "applyInterestOnPrepaymentMethod":"AUTOMATIC",
   "repaymentAllocationOrder":[
      "FEE",
      "PENALTY",
      "INTEREST",
      "PRINCIPAL"
   ],
   "interestRateSettings":{
      "encodedKey":"8a0d1ac94c0a0ed4014c0a0f8e840308",
      "interestChargeFrequency": "ANNUALIZED",
      "interestChargeFrequencyCount": 1,
      "interestRateSource":"FIXED_INTEREST_RATE",
      "interestRateTerms": "FIXED",
      "defaultInterestRate":"1"
   },
   "interestChargeFrequency":"EVERY_DAY",
   "interestCalculationMethod":"DECLINING_BALANCE",
   "interestBalanceCalculationMethod":"PRINCIPAL_ONLY",
   "interestApplicationMethod":"ON_REPAYMENT",
   "daysInYear":"E30_360",
   "scheduleInterestDaysCountMethod":"USING_ACTUAL_DAYS_COUNT",
   "loanPenaltyCalculationMethod":"NONE",
   "arrearsDateCalculationMethod":"DATE_ACCOUNT_FIRST_WENT_TO_ARREARS",
   "arrearsTolerancePeriod":0,
   "loanFees":[
      {
         "encodedKey":"8a8086be54c686d30154cd51eb200978",
         "name":"Deducted EIR",
         "amount":"100",
         "amountCalculationMethod":"FLAT",
         "trigger":"DISBURSEMENT",
         "feeApplication":"REQUIRED",
         "active":true,
         "creationDate":"2015-02-06T13:49:32+0000",
         "amortizationProfile":"EFFECTIVE_INTEREST_RATE",
         "amortizationIntervalSettings":{
            "encodedKey":"402880ee550567fc015505851cfb0014",
            "frequency":"CUSTOM_INTERVAL",
            "periodUnit":"DAYS",
            "periodCount":2,
            "intervalCount":5
         },
         "feeProductRules":[

         ]
      }
   ],
   "allowArbitraryFees":false,
   "accountingMethod":"NONE",
   "loanProductRules":[

   ],
   "interestAccruedAccountingMethod":"NONE",
   "accountLinkingEnabled":true,
   "autoLinkAccounts":false,
   "autoCreateLinkedAccounts":false,
   "settlementOptions":"PARTIAL_DUE_AMOUNTS",
   "repaymentScheduleEditOptions":[

   ],
   "taxesOnInterestEnabled":false,
   "taxesOnFeesEnabled":false,
   "taxesOnPenaltyEnabled":false,
   "arrearsNonWorkingDaysMethod":"EXCLUDED",
   "automaticallyCloseDormantAccounts":false,
   "lineOfCreditRequirement":"OPTIONAL",
   "templates":[
      {
         "encodedKey":"8a0aa3874e25265c014e253529d801e5",
         "name":"30 e 360 - Contract Template",
         "creationDate":"2015-06-24T10:55:18+0000",
         "lastModifiedDate":"2015-06-24T10:55:18+0000",
         "type":"ACCOUNT"
      },
      {
         "encodedKey":"8a0aa8494e84f2ac014e869b361c046d",
         "name":"Contract",
         "creationDate":"2015-07-13T08:49:56+0000",
         "lastModifiedDate":"2015-07-13T08:49:56+0000",
         "type":"ACCOUNT"
      },
      {
         "encodedKey":"8a0aa8494e84f2ac014e8811e8aa0cf9",
         "name":"Contract",
         "creationDate":"2015-07-13T15:39:12+0000",
         "lastModifiedDate":"2015-07-13T15:39:12+0000",
         "type":"ACCOUNT"
      },
      {
         "encodedKey":"8a0aa8494e84f2ac014e8828db560feb",
         "name":"Contract",
         "creationDate":"2015-07-13T16:04:16+0000",
         "lastModifiedDate":"2015-07-13T16:04:16+0000",
         "type":"ACCOUNT"
      },
      {
         "encodedKey":"8a6c37874e99b011014e9bc702620638",
         "name":"Test",
         "creationDate":"2015-07-17T11:29:48+0000",
         "lastModifiedDate":"2015-07-17T11:29:48+0000",
         "type":"TRANSACTION"
      },
      {
         "encodedKey":"8a099a615084353701508fd0a58964bd",
         "name":"Statement",
         "creationDate":"2015-10-22T13:50:27+0000",
         "lastModifiedDate":"2015-10-22T13:50:27+0000",
         "type":"ACCOUNT"
      }
   ],
   "productSecuritySettings":{
      "encodedKey":"8a17ed7e4f1cf5cd014f1d06e9e8007b",
      "isGuarantorsEnabled":true,
      "isCollateralEnabled":true,
      "isInvestorFundsEnabled":false,
      "requiredGuaranties":"0"
   },
   "allowGuarantors":true,
   "allowCollateral":true,
   "requiredGuarantyPercentage":"0",
   "forIndividuals":true,
   "forPureGroups":false,
   "forHybridGroups":false,
   "repaymentReschedulingMethod":"NEXT_WORKING_DAY"
}
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