Skip to main content

Status Codes & Descriptions

Overview​

This section explains the meaning of each status code returned by the system. These codes help identify the result of an operation, request, or transaction.

Understanding these categories helps developers quickly determine whether a request succeeded, failed due to client input, or failed due to a server issue.

Status Code
Status Description
Remarks
0
Success
Request processed successfully.
1
Api_Error
An error occurred on the API and your request was not successfully processed.
2
Invalid_Json
The request JSON was found to invalid.
3
Validation_Error
Your request failed some validation. Check the ValidationErrors property for more details.
4
Invalid_Api_Credentials
Your API credentials were found to be invalid. Confirm your API Key and generated hash is correct.
5
Insufficient_Customer_Balance
The customer's balance was found to be insufficient to process the invoice.
6
Invoice_Not_Found
The relevant invoice was not found.

Requests are also validated before being processed. If they fail validation, the following property will be added to the response:

ValidationErrors​

An array containing all the validation errors encountered. Each validation error object will have two properties:

  • Property:

    • The name of the property that failed the validation.

  • ErrorMessage:

    • The message describing how the property failed validation.