What is a Real-Time Response and How Does It Work?

Need for Real-Time Response:

We understand that you might prefer receiving an error code directly in the API response, rather than a generic 200 Success response, to help you identify issues with your API in real time and make necessary adjustments promptly.

How It Works:

The real-time response feature provides the error code in the second attempt of the API call, not the first. This is because during the first API call, all the parameters you pass are validated, and a cache of this call is temporarily stored. The error code is then generated and displayed when you make the second API call with the same payload.

How to Use It:

To enable real-time response, include the parameter realTimeResponse=1 in your API call. This will ensure that the error code is returned in the API response during the second attempt.

Please note that this feature is not supported in our older API versions (v2).

Error Codes Returned:

The following error codes will be displayed in the real-time response:

201

203

301

306

308

400

401

403

418

For detailed descriptions of these error codes, please refer to the article: API ERROR CODE

We hope this helps you use the real-time response feature effectively.