Trigger Repayment Status Response

This API is used by Collections Partner on the Lender to check the status of a previously initiated repayment transaction. In the case where collection is handled by Collection Management System (CMS), once the Collection Partner receives payment confirmation (including transaction reference number) from the Collection Management System, Collections Partner will send a request to the lender to check if a payment has been credited against the transaction Reference Number.

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
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.
payment 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.
response object — REQUIRED Status of response. Whether success or has encountered error status string — REQUIRED Possible values: [SUCCESS, ERROR] responseDetail string
loanId string — REQUIRED

Responses
200 Acknowledgement of Request Received Schema — OPTIONAL error string traceId string timestamp string