Error reference

info

This page is about the Dojo Pay at Counter Websockets API. If you're unsure which API is best for your integration, contact your Partnership Development Manager (PDM).

In the Pay at Counter API, error responses follow a basic logical structure:

• After sending a request, you may receive an errorResponse rather than the PUB response you were expecting.
• The result object includes:
  • The result.code, which uses standard JSON-RPC2 errors in the -32600 to -32700 range and Dojo-related errors in the -32070 to -32090 range.
  • The result.message, which is a short description of the error.
  • The result.data, which contains more detailed information about the error.
• In the example below, the result.data describes an error that has occurred because the user sent a request to a non-existent terminal.
  • The userMessage field has been configured to give a full explanation, description, and troubleshooting tips. This is a non-programmatic field. It should be used to help with human comprehension.

{
  "jsonrpc": "2.0",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "result": {
    "code": -32602,
    "message": "Invalid parameter",
    "data": {
      "terminalId": "non_existent_terminal",
      "userMessage": "Unavailable terminal or no data available for: 'non_existent_terminal'. Please check that the card machine is idle and no action is prompted on its screen, that its network and power cables are correctly connected, and that it is not in Standalone Mode. Finally, restart the card machine, and if the problem persists, please contact support."
    }
  }
}

Error reference

Error name	Code	Description
Parse error	-32700	This is a generic parse error. It means a user has included incorrect logic somewhere in their request body.
Invalid request	-32600	The request body is not valid.
Method not found	-32601	The method does not exist / is not available.
Invalid parameter	-32602	A specified parameter is invalid or does not exist.
Internal error	-32603	Internal error is a default error code covering unexpected internal errors.
Dojo error	-32070	An error has occurred, and further investigation by Dojo support may be needed.
Invalid parameter value	-32071	One or more of the received parameter values are invalid, or described in the wrong format. For example, if you use another datetime format other than ISO 8601 extended time, you will receive this error.
Request not processed	-32972	The received request has not been processed.
Response not processed	-32073	The received response has not been processed.
Request timed out	-32074	The request has timed out waiting for a response from the EPOS. Any response to this request will no longer be processed.
Unavailable terminal	-32075	The specified terminal is currently unavailable.
Connection discontinued	-32076	The connection has been unexpectedly discontinued.

Troubleshooting

If you encounter any of the below errors, consider the following steps:

• Review the API documentation: Ensure that you are using the correct methods and parameters as outlined in the Pay at Counter Websockets API Reference.
• Check parameter values: Verify that the values provided for each parameter are valid according to the API specifications.
• Ensure that your system has a stable internet connection and can communicate with the EPOS.
• Contact Dojo Support: For any unresolved issues or Dojo-specific errors, email devsupport@dojo.tech.

Introduction Return to the introduction page.

API reference Discover the full WebSockets API reference for the Dojo-only PAC API

Changelog Detailed information on recent changes to the API

Pre-authorization Learn how to use the API to reserve funds in a cardholder's account