post https://api.juspay.in/v3/disbursement/triggerDisbursementStatusRequest
This API is to be used by LSP to check the status of a previously initiated disbursement request.
Response Parameters for the Trigger Disbursement Status Request API: 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 parameters: requestId (UUID for the previous API request), and loanId (UUID for the loan whose disbursement status is being requested). An object for payment object is also included, which provides the current payment details. (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 |
| loanId | String | Unique reference ID (UUID) of the loan whose disbursement status is being requested (generated by lender). | |
| requestIdwwwwwtwww | * | String | Unique reference ID for the Trigger Disbursement Status Request (UUID used to tie request and response and for idempotency). |
| payment: {...,{...}} | * | Object | Current payment details, but is to be updated by the lender with the Trigger Disbursement Status Response API. The "id" parameter (Payment ID updated by lender) is used to check the status of the specific payment transaction. |
Parameters for the payment object:
(click to open)
| id | * | String | Unique reference ID (UUID) of the payment request (generated by LSP) |
| description | String | A short description for the payment | |
| date | Date- time | Date and time (ISO representation) when the payment transaction is done | |
| totalAmount | String | Total amount paid by the lender 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 | |
| txnRefNo | String | Receipt number of the transactions | |
| extensibleData | JSON | For any new data that needs to be added |
* = Required