metadata object — REQUIREDMetadata specific to each API request. version string — REQUIRED | originatorOrgId stringThe organisation id on the Participant Registry. | originatorParticipantId stringThe 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 — REQUIREDUUID used to tie request and response and for idempotency |
|
response object — REQUIREDStatus of response. Whether success or has encountered error status string — REQUIREDPossible values: [SUCCESS , ERROR ] | responseDetail string |
|
productData object — REQUIREDProduct Metadata specific to each API request. productId string — REQUIREDThe product id on the Product Registry. | productNetworkId stringThe product network id on the Product Registry. |
|
loanId string — REQUIRED |
lenderAccount object — REQUIRED |
loanStatus string — REQUIREDPossible 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 — REQUIREDnextRepayment object — REQUIREDtotalAmount float — REQUIRED | date date | status string — REQUIREDPossible 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 — REQUIREDPossible values: [UPI , EMANDATE_UPI , NETBANKING , ENACH , DEBIT_CARD ] | paymentUrl string | url string | extensibleData objectThis API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements. |
| currentRepayment object — REQUIREDtotalAmount float — REQUIRED | date date | status string — REQUIREDPossible 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 — REQUIREDPossible values: [UPI , EMANDATE_UPI , NETBANKING , ENACH , DEBIT_CARD ] | paymentUrl string | url string | extensibleData objectThis 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 — REQUIREDduration number — REQUIRED | unit string — REQUIREDPossible values: [MONTH , DAY , YEAR ] |
| description string — REQUIRED |
|