JSON is provided as a data format for this API.
Authorization is done through a token based approach. Authorization header with the value Bearer <token> must be supplied with every API request.
Every token has an associated expiration time. Please contact us in order to get an API token.
Possible HTTP status codes that will accompany your response form the API:
200 Success - OK201 Success - Created202 Warning - Accepted400 Error - Bad Request401 Error - Unauthorized403 Error - Forbidden404 Error - Not Found405 Error - Method Not Allowed409 Error - Conflict500 Error - Internal Server Error501 Error - Not ImplementedAlong with the HTTP status code, a more specific Application Code will accompany any error response generated by the API:
90000 Application Error90001 Bad Request90002 Authentication Failed90003 Authentication Token (Authorization) Failed90004 Not Authorized90005 Not Found90006 Not Implemented90007 Not Supported90008 Process ID (Conflict) Error90009 User Password Expired90010 Gift Provider Error90011 Gateway Provider Error90012 Loyalty Provider Error90013 Provider Configuration Error90014 Decryptor (Provider) Error90015 Account Locked Out90016 Discount Validation Provider Error90017 Invalid Certificate90018 Password Change Limit Exceeded90019 Password Repeated90020 Register Unassigned90021 Decryption Error90022 Force Auth Not Supported90023 Register Not Found90024 Provider Timeout90025 Transaction Locked90026 Tender Totals Mismatch90027 Already Exists90028 Swiped Card Data Invalid90029 Manual Card Data Invalid90030 Password Change Failed90031 Transaction Calculation Mismatch90032 Database ErrorAll errors generated by the API will include the following parameters:
ExceptionTitle (string) - Title of the error.
Message (string) - An error message suitable for display to the user.
ExceptionCode (int) - A specific code that corresponds to what type of error this is (see Application Codes).
IsInternalError (bool) - Whether or not the error occurred within the API (as opposed to within an external system such as a payment gateway).
{
"ExceptionTitle": "Not Authorized",
"Message": "Invalid context.",
"ExceptionCode": 90004,
"IsInternalError": true
}