Trigger Repayment Status Request
This API is used by LA to check the status of a previously initiated repayment transaction. In the case where collection is handled by Collection Management System (CMS), once the BA receives payment confirmation (including transaction reference number) from the Collection Management System, BA will send a request to the lender to check if a payment has been credited against the transaction Reference Number.
Request Body |
---|
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 |
|
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. |
|
payment 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. |
|
loanId string — REQUIRED |
Responses |
---|
200
Acknowledgement of Request Received Schema — OPTIONAL |
---|
error string | traceId string | timestamp string |
|