Sign in
latestOpenAPI 3.0.02026-08-133383136.3 KB

fc4f4dd68f9b

Loans

Create Loan

post/v1/loan

Headers

accept-languagestring

Language of the response, supported languages: en-us, in

idempotency-keystring

Idempotency Key for retries

Request body

customerReferenceNostring required

Customer Reference number. Each customer has unique reference number. Enter reference number of the customer for whom loan should be created.

  • /^S*$/
loanAmountnumber required

Loan Amount.

  • Support decimal values as well.
loanType'BNPL' | 'GMV' | 'BNPL_Term' | 'GMV_Term' required

Type of loan.

We support these two types,

  1. BNPL - Buyer Financing

  2. GMV - Seller Financing

loanTerm30 | 45 | 60 | 90 | 120 | 150 | 180 | 210 | 240 | 270 | 300 | 330 | 360 required

Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be.

remarkstring

Comments if any.

metadatastring

Metadata for loans. It can be used for reporting, reconciliation purpose.

preApprovedboolean

Flag to create pre-approved loan, Default value will be true.

Example request

{
  "customerReferenceNo": "c3eb1619-ff24-4773-97d8-b05264621e60",
  "loanAmount": 50000,
  "loanType": "BNPL",
  "loanTerm": 30,
  "remark": "Loan for xyz ltd, construction purpose",
  "preApproved": true
}

Response

Loan created successfully

statusCodenumber required

The HTTP status code of the error

messagestring required

Human-readable message containing all available details about the operation

successboolean required

A boolean indicating whether this was a success response or an error response

Example response

{
  "data": {
    "loanTerm": 30,
    "loanType": "BNPL",
    "loanStatus": "waiting-for-disbursal",
    "loanDueDate": "21 August 2023",
    "loanDueDateUTC": "2023-08-20T18:30:00.000Z",
    "dueDatePostGracePeriod": "24 August 2023",
    "dueDatePostGracePeriodUTC": "2023-08-23T18:30:00.000Z",
    "gracePeriodInDays": 3
  }
}