Skip to main content

Loan Summary Response

This API is invoked by the LA once the borrower completes successful signing of the loan agreement to create the actual loan in the lender’s system.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

response object REQUIRED

Status of response. Whether success or has encountered error

status string REQUIRED

Possible values: [SUCCESS, ERROR]

responseDetail string
productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

loanId string REQUIRED
lenderAccount object REQUIRED
loanStatus string REQUIRED

Possible values: [EMI_DUE, EMI_PAID, EMI_OVERDUE, EMI_WAIVED, LOAN_CLOSED, NPA, PARTIALLY_PAID, PRECLOSURE, SETTLEMENT_STARTED, SETTLEMENT_COMPLETED, SETTLEMENT_FAILED, SETTLEMENT_PAID, HEALTHY]

createdDate string REQUIRED
startDate string REQUIRED
endDate string REQUIRED
summary object REQUIRED
nextRepayment object REQUIRED
totalAmount float REQUIRED
date date
status string REQUIRED

Possible values: [SUCCESS, FAILURE, PENDING_AUTH]

installmentNumber number
txnRefNo string
id string REQUIRED
description string
principal float
interestAmount float
fee float
penalty float
useSavedPaymentOption boolean
paymentMethodType string REQUIRED

Possible values: [UPI, EMANDATE_UPI, NETBANKING, ENACH, DEBIT_CARD]

paymentUrl string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

currentRepayment object REQUIRED
totalAmount float REQUIRED
date date
status string REQUIRED

Possible values: [SUCCESS, FAILURE, PENDING_AUTH]

installmentNumber number
txnRefNo string
id string REQUIRED
description string
principal float
interestAmount float
fee float
penalty float
useSavedPaymentOption boolean
paymentMethodType string REQUIRED

Possible values: [UPI, EMANDATE_UPI, NETBANKING, ENACH, DEBIT_CARD]

paymentUrl string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

principalPaid string REQUIRED
interestPaid string REQUIRED
penaltyPaid string REQUIRED
principalPending string REQUIRED
interestPending string REQUIRED
amountDisbursed string REQUIRED
amountRepaid string REQUIRED
tenure object REQUIRED
duration number REQUIRED
unit string REQUIRED

Possible values: [MONTH, DAY, YEAR]

description string REQUIRED
Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string