Trigger Collections Request

This API is invoked by the Lender to inform the Collections partner to trigger a repayment. This API will only be called when payment is routed to lender via collection agent.

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.
paymentMethod object id string — REQUIRED description string type string Possible values: [EMANDATE_UPI, ELIEN, ENACH, ANY] status string — REQUIRED Possible values: [INACTIVE, ACTIVE, CANCELLED, PAUSE] data object This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements. 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.
loanId string — REQUIRED

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