post https://api.juspay.in/v3/disbursement/setDisbursementAccountRequest
This API is invoked by the LSP to inform the lender about the disbursement account that the borrower has chosen.
Response Parameters for the Set Disbursement Account Request 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 must include either loanId or loanApplicationId, depending on whether the loan has been granted. An object for account is also sent, which includes an account ID and other optional information. (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 Set Disbursement Plan Request (UUID used to tie request and response and for idempotency) |
| loanApplicationId | * | String | Unique reference ID (UUID) for the loan application already created by LSP in previous APIs. To be passed only when this API is called before the Grant Loan API request. |
| loanId | * | String | Unique reference ID (UUID) of the loan whose disbursement account is being set (generated by lender) To be passed only if this API is called after the Grant Loan API request. |
| account: {param1, param2,...} | * | Object | Details of the disbursement account chosen by the borrower for the loan |
Parameters for the account object:
(click to open)
| id | * | String | Unique reference ID (UUID) of the disbursement account chosen by the borrower 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 | |
| accountDataTypewwt | 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. |
* = Required * = Conditional