post https://api.juspay.in/v3/disbursement/getDisbursementAccountsResponse
This API is invoked by the lender to inform the LSP about the list of disbursement accounts available for the loan
Response Parameters for the Get Disbursement Accounts Response API: w w (click to view)
| Parameter | Type | Description |
|---|---|---|
| ack:wwwwtwwww {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 an array of objects for accountList, where each object contains details of a disbursement account available for the specified loan. (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 Get Disbursement Accounts 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. | |
| accountList: [{...},{...},..] | * | Array of Objects | Details of all disbursement accounts available for the specified loan. |
Parameters for each object in the accountList array:
(click to open)
| id | * | String | Unique reference ID (UUID) of a disbursement account available for the given loan. Mandatory if object is coming from lender (generated by lender) |
| description | String | Description of the account | |
| status | String | This field captures the status of whether the account has been linked to a loan or not | |
| accountDataTypewwi | String | This suggests what kind of data is expected for account details in the data object | |
| url | String | For any new data that needs to be passed as a link. | |
| extensibleData | JSON | For any new data that needs to be added | |
| data: {param1, param2,..} | Object | This object captures details of the account as suggested by the accountDataType parameter (Parameters are variable). |
Parameters for the data object:
(click to open)
| accountType | String | Type of account Example: "CURRENT" | |
| accountIFSC | String | IFSC code of the account | |
| accountNumber | String | Account Number | |
| vpa | String | VPA code of borrower | |
| maskedAccountNumber | String | Account number shown masked except for the last 4 digits. |
* = RequiredNote: This request should also include the "loanId" parameter, which was the reference ID in the previous request for the loan whose disbursement accounts were to be retrieved.