Errors

Errors in the OpenTransact API in general follow the specification for JSON-API. You can find more info here: https://jsonapi.org/format/#error-objects . The error should provide enough detail for you to fix the issue with your request. If not please contact support@opentransact.com with the details of the error.

Example Error

  {
    "errors": [
      {
        "status": "404",
        "title": "Not Found",
        "detail": "Could not locate requested resource" ,
        "code": "10001"
      }
    ]
  }

Common Errors

The following is a table of errors that are returned by the API for common issues.

Error NameError CodeHTTP Status CodeError Detail
Not Found10001404Could not locate requested resource
Unauthorized10002401Unauthorized request.
Missing Authorization Header10003401See: https://docs.opentransact.com/authentication/.
Authorization Token Expired10004401See: https://docs.opentransact.com/authentication/.
Unauthorized10005401See: https://docs.opentransact.com/authentication/.
Missing Required Request Parameter10006422The request param %{attribute} is missing.
Incorrect Type for Parameter10007422%{attribute} cannot be of type null
Incorrect Type for Parameter10008422%{attribute} cannot be of type String. See: https://docs.opentransact.com/types/.
Incorrect Type for Parameter10009422%{attribute} cannot be of type Boolean. See: https://docs.opentransact.com/types/.
Incorrect Type for Parameter10010422%{attribute} cannot be of type Array. See: https://docs.opentransact.com/types/.
Incorrect Type for Parameter10011422%{attribute} cannot be of type Object. See: https://docs.opentransact.com/types/.
Incorrect Type for Parameter10012422%{attribute} cannot be of type Number. See: https://docs.opentransact.com/types/.
Invalid Param Value10013422%{attribute} must be set to a whitelisted value.
Invalid Type Param10014422Type param must be set to '%{attribute}' for the requested resource.
Forbidden10015403
Missing Required Request Parameter10015422The query string param %{attribute} is missing.
Bad Gateway10016502
Non-permitted Parameter10016422%{attribute} is not a permitted parameter.
Incorrect Type for Parameter10017422%{attribute} cannot be of type Float
Idempotency Key Conflict10018409An identical request has already been processed.
Idempotency Key Conflict10019409The provided Idempotency-Key was previously used with a diferent request.
Missing Required Attribute11001422%{attribute} can't be blank
Invalid Attribute11002422%{attribute} is not valid
Invalid Attribute11003422%{attribute} must be unique
Cannot Transition State11004422%{attribute}
Missing Required Relationship11005422%{attribute} could not be located
Record Exists11006422Record already exists for %{attribute}
Invalid Attribute11007422%{attribute} value is too long
Unrelated Objects Provided11008422%{attribute} is unrelated to data provided
Invalid account type12001422%{attribute} value not supported
Invalid transaction type12002422#&#123attribute} value is invalid
Invalid transaction method12003422The combination of transaction type and account type is unsupported.
Invalid currency12004422We do not support the supplied currency.
Invalid precision12005422We do not support the supplied precision.
Invalid Account12006422The supplied account is not currently active.
Account or Payment Method Required12007422One of either Account or Payment Method must be provided.
Item is Not Returnable12008422A return cannot be created for the related item.
Item has already been returned12009422A return cannot be created for the related item, which has previously been returned.
Refund would exceed transaction amount13001422Total refunds may not be greater than the original transaction amount.
Invalid Expiration Date13002422The expiration date is in an invalid format.
Bank or Branch Must Be Set13003422Either the bank or the branch must be set to a valid value.
Bank and Branch Both Set13004422Both the Bank and Branch values cannot be set simultaneously.
Permission Statement Invalid13005422The permisison statement is invalid.

Was this page helpful?