Set Repayment Plan Status Request

This API is used by LA to check the status of a previously initiated set repayment plan request. This API is called once the payment page of the lender is loaded and the borrower choses a repayment method associated with the chosen repayment plan.

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.
plan object — REQUIRED id string — REQUIRED title string shortDescription string description string paymentUrl string payNowAllowed boolean editPlanAllowed boolean changeMethodAllowed boolean automatic boolean — REQUIRED scheduleType string — REQUIRED Possible values: [RECURRING, ONE_TIME, AS_PRESENTED] noOfInstallment number frequency string Possible values: [MONTHLY, WEEKLY, QUARTERLY, HALF_YEARLY, YEARLY] tenure object duration number — REQUIRED unit string — REQUIRED Possible values: [MONTH, DAY, YEAR] totalAmount float — REQUIRED principal float interestAmount float penalty float startDate date status string Possible values: [ACTIVE, INACTIVE, PENDING_AUTH] 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 — REQUIRED 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
loanApplicationId string — REQUIRED

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