post https://api.juspay.in/v3/loan/loanSummaryResponse
This method is called be the Lender as a response to Loan Summary Request.
Response Parameters for the Loan Summary Response API: (click to view)
Parameter | Type | Description |
---|---|---|
ack:wwwwwwww {error, traceId, timestamp} | Object | JSON object for acknowlegement |
Parameters for the
ack
object: Parameter | Type | Description |
---|---|---|
error | String | Errors in the current request received. If no errors are found, error = 0. |
traceId | String | Identification for tracing |
timestamp | Time- stamp | YYYY-MM-DDThh:mm:ssZ+/-hh:mm (eg 1997-07-16T19:20:30+05:30) Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30) |
The request for this API consists of status parameters, plus a Summary object, which contains objects for nextRepayment and currentRepayment. (click to open tables)
Parameter | Type | Description | |
---|---|---|---|
metadata:wwwwwwnww {param1, param2,...} | * | Object Strings | Metadata specific to each API request |
Parameters for the metadata
object: click to open)
Field | Type | Description | |
---|---|---|---|
version | String | OCEN Version | |
timestamp | Time- stamp | YYYY-MM-DDThh:mm:ssZ+/-hh:mm (eg 1997-07-16T19:20:30+05:30) Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30) | |
traceId | String | Identification for tracing | |
orgId | String | Origin ID |
response: {error} | Object | Status of response. Object contains only one string parameter for "error". If no errors are found, error = "0". For example, if a mandatory attribute is missing, error code should capture that. | |
requestId wwwwwwwnwwwwwww | * | String | Unique reference ID for the Loan Summary Request (UUID used to tie request and response and for idempotency) |
loanId | * | String | Unique reference ID (UUID) of the loan whose status is being enquired (generated by lender) |
loanStatus | * | String | If loan is being processed:loanStatus = "GENERATED"After loan is processed: loanStatus = GRANTED / REJECTED / DEFAULTED / COMPLETED / ACTION_REQUIRED |
createdDate | String | Date when loan was created | |
startDate | String | Date from when loan is active | |
endDate | String | End date till when loan is active | |
summary: {.., {...}, {...}, ..} | * | Object | Summarized details of the loan |
Parameters for the summary
object: (click to open)
nextRepayment: {param1, param2,...} | * | Object Strings | Details of next repaymentwww |
Parameters for the nextRepayment
object:
(click to open)
id | String | UUID for the payment request (generated by LSP) | |
description | String | A short description of the payment | |
status | String | Preliminary status for next payment | |
totalAmountwwwwiiw | * | String | Total amount to be paid by borrower for next installment - 2 digit precision |
principal | String | Principal amount to be paid by the borrower for the next payment - 2 digit precision | |
interestAmount | String | Interest amount to be paid by the borrower for the next payment - 2 digit precision | |
penalty | String | Penalty to be paid by the borrower for the next payment - 2 digit precision | |
fee | String | Fees to be paid by the borrower by the borrower for the next payment - 2 digit precision | |
date | Time- stamp | Date and time when the next payment transaction is complete (to be populated when payment is done) | |
installmentNumber | String | The installment number for the next payment | |
paymentMethodTypet | String | Payment method used for the transaction (to be populated when payment is done) | |
paymentUrl | String | URL for the payment page | |
txnRefNo | String | Receipt number of the transactions (to be populated when payment is done) | |
extensibleData | JSON | For any new data that needs to be added |
useSavedPaymentOption | Boolean | true if using the Saved Payment Option |
currentRepayment: {param1, param2,...} | * | Object Strings | Details of current repaymentw |
Parameters for the currentRepayment
object:
(click to open)
id | String | UUID for the payment request (generated by LSP) | |
description | String | A short description of the payment | |
status | String | Status of the current payment transaction | |
totalAmount | * | String | Total amount paid by the borrower for the current payment - 2 digit |
principal | String | Principal paid by the borrower for the current payment - 2 digit precision | |
interestAmount | String | Interest amount paid by the borrower for the current payment - 2 digit precision | |
penalty | String | Penalty paid by the borrower for the current payment - 2 digit precision | |
fee | String | Fees paid by the borrower for the current payment - 2 digit precision | |
date | Time- stamp | Date and time when the payment transaction is done | |
installmentNumber | String | The installment number for the current payment | |
paymentMethodTypen | String | Payment method used for the transaction. To be populated when payment is done | |
paymentUrl | String | URL for the payment page | |
txnRefNo | String | Receipt number of the transactions | |
extensibleData | JSON | For any new data that needs to be added |
useSavedPaymentOption | Boolean | true if using the Saved Payment Option |
principalPaidwwwwwww | * | String | Principal paid to date |
interestPaid | String | Interest paid to date | |
penaltyPaid | String | Penalty paid to date | |
principalPending | String | Principal pending | |
interestPending | String | Interest pending | |
amountDisbursed | String | Amount disbursed to date | |
amountRepaid | String | Amount repaid to date | |
tenure: {duration, unit} | Object Strings | Tenure details:duration String unit String (DAY, MONTH, etc.) | |
description | String | Short description of the loan |
* = Required