post https://api.juspay.in/v3/repayment/triggerRepaymentResponse
This API is invoked by the lender to the LSP giving the lender payment page url from where the borrower can make the payment. Lender also generates an ID for the payment which becomes the reference for LSP to check the status of repayment.
Response Parameters for the Trigger Repayment Resonse API: w w w (click to view)
| Parameter | Type | Description |
|---|---|---|
| ack:wwwwwwww {error, traceId, timestamp} | Object | JSON object for acknowlegement |
Parameters for the
ack object: | Parameter | Type | Description |
|---|---|---|
| error | String | Errors in the current request received. If no errors are found, error = 0. |
| traceId | String | Identification for tracing |
| timestamp | Time- stamp | YYYY-MM-DDThh:mm:ssZ+/-hh:mm (eg 1997-07-16T19:20:30+05:30) Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30) |
The request for this API contains the parameter: requestId (UUID for the previous API request) and a payment object, which provides new payment details, such as status indication, payment URL, and a new ID for the payment. (click to open tables)
| Parameter | Type | Description | |
|---|---|---|---|
| metadata:wwtwwwww {param1, param2,...} | * | Object Strings | Metadata specific to each API response |
Parameters for the metadata object: click to open)
| Field | Type | Description | |
|---|---|---|---|
| version | String | OCEN Version | |
| timestamp | Time- Stamp | YYYY-MM-DDThh:mm:ssZ+/-hh:mm (eg 1997-07-16T19:20:30+05:30) Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30) | |
| traceId | String | Identification for tracing | |
| orgId | String | Origin ID |
| requestIdwwwwwtwww | * | String | Unique reference ID for the Trigger Repayment Request (UUID used to tie request and response and for idempotency) |
| response: {error} | Object | Object contains one parameter, "error:", which indicates if any errors were found in the current request received. If none are found, error = 0. | |
| payment: {...,{...}} | * | Object | Updated payment details |
Parameters for the payment object:
(click to open)
| id | * | String | New unique reference ID (UUID) of the payment (originally generated by LSP, but updated by lender) |
| description | String | A short description for the payment | |
| date | Date- time | Date and time (ISO representation) of the payment transaction. To be populated when the transaction is done. | |
| principal | String | Principal paid by the borrower for the current payment - 2 digits precision | |
| interestAmount | String | Interest amount paid by the borrower for the current payment - 2 digit precision | |
| fee | String | Fees paid by the borrower for the current payment - 2 digits precision | |
| penalty | String | Penalty paid by the borrower for the current payment - 2 digits precision | |
| totalAmount | String | Total amount paid by borrower for the current payment - 2 digit precision | |
| installmentNumber | String | The installment number for the current payment | |
| status | * | String | Status of the current payment transaction |
| useSavedPaymentOption | Boolean | true if using the Saved Payment Option | |
| paymentMethodType | String | Payment method used for the transaction. To be populated when payment is done | |
| paymentUrl | * | String | URL of the payment page |
| txnRefNo | String | Receipt number of the transactions | |
| extensibleData | JSON | For any new data that needs to be added |
* = RequiredNote: This request should also include the loanId parameter, which is a reference for the loan whose repayment was to be triggered.