Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Set Disbursement Account Request

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)
ParameterTypeDescription
ack:wwwwwwww
  {error, traceId, timestamp}
ObjectJSON object for acknowlegement
    Parameters for the ack object:
ParameterTypeDescription
errorStringErrors in the current request received. If no errors are found, error = 0.
traceIdStringIdentification for tracing
timestampTime-
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)
ParameterTypeDescription
metadata:wwtwwwww
   {param1, param2,...}
*Object
Strings
Metadata specific to each API response
  Parameters for the metadata object:     click to open)
FieldTypeDescription
versionStringOCEN Version
timestampTime-
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)
traceIdStringIdentification for tracing
orgIdStringOrigin ID
requestIdwwwwwtwww*StringUnique reference ID for the Set Disbursement Plan Request (UUID used to tie request and response and for idempotency)
loanApplicationId*StringUnique 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*StringUnique 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,...}
*ObjectDetails of the disbursement account chosen by the borrower for the loan
  Parameters for the account object:
      (click to open)
id*StringUnique 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)
descriptionStringDescription of the account
statusStringThis field captures the status of whether the account has been linked to a loan or not
accountDataTypewwtStringThis suggests what kind of data is expected for account details in the data object
urlStringFor any new data that needs to be passed as a link.
extensibleDataJSONFor any new data that needs to be added
data:
  {param1, param2,..}
ObjectThis object captures details of the account as suggested by the accountDataType parameter (Parameters are variable).
  Parameters for the data object:
      (click to open)
accountTypeStringType of account
Example: "CURRENT"
accountIFSCStringIFSC code of the account
accountNumberStringAccount Number
vpaStringVPA code of borrower
maskedAccountNumberStringAccount number shown masked except for the last 4 digits.
* = Required
* = Conditional
Language
Click Try It! to start a request and see the response here!