post https://api.juspay.in/v3/loan/triggerLoanAcceptanceRequest
This API is invoked by the LSP when the user agrees to the terms of the agreement. The Asynchronous response for this API should include the lender sending an OTP to the phone number associated with the disbursement account.
Response Parameters for the Trigger Loan Acceptance Request API: (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 an array of strings, loanApplicationIds, and an array of objects, Credit Block. Each object contains a parameter, type, and a Data object, which provide type of credential infomation and associated data, such as appToken. (click to open tables)
Parameter | Type | Description | |
---|---|---|---|
metadata:wwwwwwtnww {param1, param2,...} | * | Object Strings | Metadata specific to each API request |
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 |
requestId wwwwwwwnwwwwwww | * | String | Unique reference ID for the Trigger Loan Acceptance Request (UUID used to tie request and response and for idempotency) |
loanApplicationIds: [....] | * | Array of Strings | UUID for the loan applications generated by the LSP. These are the list of loan applications for which borrower has agreed to and wants to accept terms. |
credBlock: [{...}, {...}, ...] | * | Array of Objects | Credential information to be used for triggering loan acceptance. |
Parameters for each object in the creditBlock
array:
(click to open)
typewwwwwwwwwwww | * | String | Type of credential used for triggering loan acceptance. Example: "OTP" |
data:wwwwwwnnw {param1, param2,...} | * | Object Strings | Credential InformationappToken , etc. |
Parameters for the data
object: (click to open)
appTokenwwwwwiww | * | String | If type = "OTP", this is the token for the OTP to be sent by the lender to the phone number associated with the disbursement account. |
{{Field}} | String | {{value}} | |
{{Field}} | String | {{value}} Other parameters as needed |
* = Required