Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and what matters is that you get back information about what happened. We will send back specific error status codes, error messages and error types to help you debug what's going wrong.

All responses will come back with a status code, and a message. All successful API requests will come back with a 200 for the status code, letting you know the operation was successful. If the status code is not 200, then an error has occured and you can follow up with the error code and status message to understand what went wrong.

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Digital Pay Works support.

Status codes

Here is a list of the different categories of status codes returned by the Digital Pay Works API. Use these to understand if a request was successful.

  • Name
    2xx
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Description

    A 4xx status code indicates a client error — this means it's a you problem.

  • Name
    5xx
    Description

    A 5xx status code indicates a server error — this an us problem.

Error types

Whenever a request is unsuccessful, the Digital Pay Works API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. The error messages are helpful and actionable.

Here is a list of a few of the error types supported by the Digital Pay Works API — use these to understand what has gone wrong.

  • Name
    missing_param_error
    Description

    You are missing one or more params in your request. Please see message for detailed output of which param is missing.

  • Name
    endpoint_does_not_exists
    Description

    This means that you made an error, which is much more likely.

  • Name
    missing_secret_key
    Description

    You are missing your secret key from the auth header.

  • Name
    invalid_secret_key
    Description

    The secret key you passed in is either expired or wrong.

  • Name
    missing_public_key
    Description

    You are missing your public key from the auth header.

  • Name
    invalid_public_key
    Description

    The public key you passed in is either expired or wrong.

Error response

{
  "type": "missing_param_error",
  "message": "Missing the item field in request",
  "documentation_url": "https://protocol.chat/docs/errors/missing_param_error"
}

Was this page helpful?