post https://api.juspay.in
This API is invoked by the Lender when the Lender sends out an OTP to the phone number associated with the disbursement account. This API is an asynchronous response to the OTP trigger request by the LSP.
Response Parameters for the Trigger Loan Acceptance Response 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 objects, Credit Block. Each object contains a parameter, type, and a Data object, which provide type of credential infomation and associated data, such as otpSessionKey and maskedPhoneNumber. (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 |
| response: {error} | Object | Status of response. Object contains only one string parameter for "error". If no errors are found, error = "0". For example, if a mandatory attribute is missing, error code should capture that. | |
| requestId wwwwwwwnwwwwwww | * | String | Unique reference ID for the Trigger Loan Acceptance Request (UUID used to tie request and response and for idempotency) |
| credBlock: [{...}, {...}, ...] | * | Array of Objects | Credentials block which contains details for triggering and accepting loan |
Parameters for each object in the creditBlock array:
(click to open)
| typewwwwwwwwwwww | * | String | Type of credential used for triggering and accepting loan . Example: "OTP" |
| data:wwwwwwnnw {param1, param2,...} | * | Object Strings | Credential InformationotpSessionKey, maskedPhoneNumber, etc. |
Parameters for the data object: (click to open)
| otpSessionKeywww | * | String | If type = "OTP", this is the key to be used for the loan acceptance session |
| maskedPhoneNumber | * | String | If type = "OTP", This is the partially masked phone number associated with the disbursement account. |
| {{Field}} | String | {{value}} | |
| {{Field}} | String | {{value}} Other parameters as needed |
* = Required