POST
/
loans
curl --request POST \
  --url https://spark.test.woodcore.co/api/v2/loans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clientId": 1092,
  "createdDate": "15 Mar 2022",
  "duration": 12,
  "durationBy": "Month",
  "expectedDisbursementDate": "15 Mar 2022",
  "interestRate": 5,
  "interestType": "Flat",
  "linkDepositAccountId": 454,
  "loanType": "individual",
  "numberOfRepayments": 12,
  "principal": 100000,
  "productId": 1,
  "repaymentEvery": 1,
  "repaymentFrequency": "Monthly"
}'
{}

​
Create Loan Account

A loan account application can be created by using this endpoint.

Field Description
FieldDescriptionType
clientIdThe client submitting a loan application.Integer
productIdDesccribes the Identifier of the loan product associated with the loan application. The loan application inherits some of the information from its associated loan product.Integer
principalThe loan amount to be disbursed to through loan.Integer
durationThe loan term period to use. e.g. 10,12Integer
durationByDescribes the type of duration cycle to be used for the loan. Available values include: [Month, Year]String
loanTypeTo represent different type of loans. At present there are three type of loans are supported. Available loan types: individual: Loan given to individual member. group: Loan given to group as a whole. jlg: Joint liability group loan given to members in a group on individual basis. JLG loan can be given to one or more members in a group.String
numberOfRepaymentsThis is the number of installments to repay. e.g 1 (repayments) every 12 months.Integer
repaymentEveryThis is used like numberOfRepayments e.g 1 (repayments) every 1 month.Integer
repaymentFrequencyThis describes the frequency of payments for the loan. Available options include: [Monthly, Yearly]String
interestRateThis describes the rate of interest calculated on the principal amount of the loan.Integer
interestTypeDescribes the type of interest calculated on the loan. Examples include: fiat, declining, e.t.c.String.
linkDepositAccountIdDescribes the Identifier of the savings account to be linked to the loan account.Integer
expectedDisbursementDateThe proposed disbursement date of the loan so a proposed repayment schedule can be provided.String
createdDateThe date the loan application was submitted by applicant.String
dateFormatThe default date format on WoodCore “dd MMMM yyyy”String
locale”en” by defaultString

​
Parameters

  • woodcoretenant (header, string, required: False): Example: default

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Response

200 - application/json

ddddd

The response is of type object.