Response

{
    status: "success", // mandatory
    code: "200", // mandatory
    message: "Transaction successful",  // optional
    data: {} // optional
    errors: [] // optional
}

Transaction status: can be "pending", "success", "error"

Only HTTP Response (code 200 - OK + status: success) means the transaction/activity request is successful, every other response code means that the request failed.

You may get an HTTP status code (200 - Ok + status: pending). For such transactions please use the re-query service to confirm the real and final status of the transaction as we rely on third-party providers and so are unable to ascertain the final status as at the time the response was sent.

Failures usually result in an HTTP status code that is not 200, (i.e. 400, 500, 503 etc.) however, it is important to watch out for the code property directly in the main response body before you make a decision on whether the transaction has truly failed. All possible error codes are listed under the codes section below on this page

For failed requests, containing any of these codes listed here in the response body, Kindly do a re-query to confirm the real status of the transaction as these transactions may later result in a "successful" or a "failed" transaction as the case may be.

BX0001 - Connection Timeout: Retried 3 times and no response from the provider.
BX0019 - Request status unknown, Connection Timeout
BX0021 - Transaction status unknown: Please re-query to confirm final status
BX0024 - No response from the connecting service provider
EXC00103 - Requested service is not active.
EXC00105 - Balance could not be obtained.
EXC00109 - Service is blocked.
EXC00114 - Exchange is still pending
EXC00124 - The provider platform did not respond in a timely manner.
UNK0001 - Unknown error on the platform
EXC00001 - Bad Gateway From Provider (Requery)

Basic/Standard HTTP Status Codes:

200 - Successful
400 - Bad requests
401 - Unauthorized / Authentication / Authorization Issues
422 - Bad requests from request field validation errors
500 - Failure in processing transactions or users requests

Possible Codes that may be returned in the response body:

The "code" property of the response object can be any of the error codes that will be shared below.