Set Repayment Plan Status Response / Webhook

This API is used by lenders to inform LA about the status of a previously initiated set Repayment.The API returns the status of the repayment plan that the borrower has chosen. In case, the borrower has chosen e-mandate as the repayment method in payment page url, the status of the repayment plan becomes ACTIVE only after successful authorization of the e-mandate on the PSP by the borrower.

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.
response object — REQUIRED Status of response. Whether success or has encountered error status string — REQUIRED Possible values: [SUCCESS, ERROR] responseDetail string
loanApplicationId string — REQUIRED
loanApplicationStatus string — REQUIRED Possible values: [CREATED, PROCESSING, CONSENT_INITIATED, CONSENT_RECEIVED, CONSENT_REJECTED, OFFERED, OFFER_ACCEPTED, KYC_INITIATED, KYC_COMPLETED, KYC_FAILED, KYC_REJECTED, LOAN_AGREEMENT_INITIATED, LOAN_AGREEMENT_COMPLETED, LOAN_AGREEMENT_FAILED, REPAYMENT_SETUP_INITIATED, REPAYMENT_SETUP_COMPLETED, REPAYMENT_SETUP_FAILED, REPAYMENT_SETUP_REJECTED, SET_DISBURSEMENT_ACCOUNT_INITIATED, SET_DISBURSEMENT_ACCOUNT_COMPLETED, SET_DISBURSEMENT_ACCOUNT_FAILED, SET_DISBURSEMENT_ACCOUNT_REJECTED, GRANTED, REJECTED, ACTION_REQUIRED, DISBURSEMENT_INITIATED, DISBURSEMENT_COMPLETED, DISBURSED_FAILED, CLOSED, CANCELLED]
loanId string
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.
useCollectionSupport boolean — REQUIRED

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