EDIS Inquiry
This API allows you to check the status of an authorisation using its transaction ID.
USE CASE
Confirm that an authorisation went through before allowing the sell.
The response counts the holdings that succeeded and failed.
Note
Transaction ID must be base64 encoded.
Transaction ID to be base64 encoded in payload. please refer to the online tool for conversion.
Details
- This Api is used to get the information/status of the provided transaction Id for the respective holdings you have on your end.
- Send one
transactionIdin the request body, Base64-encoded. Take the value from EDIS Details and encode it before sending. - The response returns
SUCEESS_CNTandFAILED_CNT, the number of holdings that succeeded and failed under that transaction ID. The keySUCEESS_CNTis spelled this way in the API. - The response gives counts only. For the quantities, dates and status text of completed authorisations, call EDIS Details.
- Rate limits differ between the Standard and Prime plans. See Plans & rate limits.
Request Attributes
| Attribute | Data Type | Description |
|---|---|---|
transactionId | string | The transaction ID to check the status/information for; must be base64 encoded in the payload. |
Response Attributes
| Attribute | Data Type | Description |
|---|---|---|
s | string | Request status indicator: "ok" for success, "error" for failure. |
code | int | Response status code. |
message | string | Descriptive message about the response. |
FAILED_CNT | int | Number of holdings/transactions that failed under the given transaction ID. |
SUCEESS_CNT | int | Number of holdings/transactions that succeeded under the given transaction ID. |
Last updated on