post https://api.juspay.in/v3/consent/consentStatusRequest
This API is invoked by the LSP to check the status of Consents.
Response Parameters for the Consent Status Request API:
(click to view)
(click to view)
| Parameter | Type | Description |
|---|---|---|
| ack:wwwwwwwwwwwwwww {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 includes an object for Consent, which contains the identifier for consentHandle. (click to open tables)
| Parameter | Type | Description | |
|---|---|---|---|
| metadata:wwwwtwwwww {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 |
| requestIdwwwwwwwtwww | String | Unique reference ID for the Consent Handle Request (UUID used to tie request and response and for idempotency) | |
| consent: {...} | Object | This includes the consent handle used to identify the consent. |
Parameters for the consent object: (click to open)
| consentHandle | String | ID for the consent handle created by the AA for the lender once the Consent Handle Request API is triggered. Sending this will trigger the lender to check again with the AA for updates in bank account statements, GST historical data,etc. | |
| consentStatus | String | Status of the consent Example: "READY" |
* = Required