HTTP Status Codes

A few important things to note:

🚧

Error Treatment

  1. A 400 Series Error is usually something that you can fix by changing something in your request.
  2. A 500 Series Error is usually something that you need to contact us ([email protected]) to look at.
    1. If we determine that a 500 Series Error can be fixed by you, we will try to change this error situation to a 400 Series Error in a future code release.
  3. If you receive a 207 while using any resource, please contact [email protected] for assistance.

🚧

Please inform us of possible Volume Spikes.

If you do not inform us of unexpected Volume Spikes, our systems may detect it as abnormal and our systems may block all IP Addresses causing this unexpected Volume Spikes. Volume Spikes that are all (or mostly) Errors, like:

  1. SC=404 coming from Retrieve Transactions
  2. SC=409 coming from Create Accounts or Create Transactions

will expedite this block of IP Addresses.

HTTP Response Codes

Status Code Status Description
200 OK The API Request was successfully processed.
201 Created Transaction Created, but Transaction Processing is Pending (batch).
207 Multi-Status One or more upstream processing failed. Causes include:
  • A Network Timeout. The Resource is in an UNKNOWN status.
  • An upstream process' response is corrupted or abnormal.
If you receive a 207 while using any resource, please contact [email protected] for assistance.
400 Bad Request Causes include:
  • The ResourceID is invalid
  • Request Body is malformed (e.g. Not JSON or JSON contains not packed/contains newlines)
  • One or more request body parameters are incorrect or invalid
401 Unauthorized 401 Causes Include:
  • The Bearer Token is invalid or incorrect. Make sure the Bearer Token is correct.
  • The IP Address has not been allowed.
For Bearer Token renewals or help with IP whitelisting, contact [email protected] for assistance.
403 Forbidden 403 Causes Include:
  • Permissions do not allow accesss to the resource. Response body will be in JSON format, and "EM" will include "Permission
  • The IP Address is not allowed. Response body will be in XML format
Please contact [email protected] (with the full request body/response body/URL used/timestamp with timezone) for assistance.
404 Not Found 404 Causes Include:
  • The ResourceID does not point to a valid Resource.
  • The URL is invalid
  • The ClientID in the URL is invalid
  • The AccountID/TransactionID/ReferenceID/etc. is not found
405 Method Not Allowed HTTP Request Method Not Allowed for the Requested Resource. Examples Include:
Please make sure you are using the right method for this resource.
406 Not Acceptable Our Web Application Firewall (WAF) found something invalid in your request. Cause include:
  • Invalid characters in your request.
  • JSON Formatting is invalid.
409 Conflict 409 Causes Include:
  • ReferenceID has already been used in CreateTransaction
  • CreateAccount if using ?RejectDuplicateCard. See Duplicate Card Check FAQ for more information.
  • Conflicting request parameters. Reread the API specifications to ensure you're providing consistent and correct request parameters.
410 Gone 410 Causes Include:
  • The Resource pointed to by the ResourceID has been marked for deletion.
  • Calling DeleteAccount on an AccountID that has already been deleted.
  • Calling DeleteKey on a KeyID that has already been deleted.
415 Unsupported Media Type Content-type must be application/json.
421 Misdirected Request Too late to Retrieve by ReferenceID, use AccountID or TransactionID.
422 Unprocessable Entity 422 Causes Include:
  • The Resource pointed to by the ResourceID is in an invalid state
  • Request exceeds your configured Transaction Limit. "EM" will contain "Transaction Limit". Perform RetrieveClient to check your Transaction Limits.
  • The card you are trying to push to or pull from is inaccessible with your current configurations. "EM" will include "Destination Disabled" or "Source Disabled". Perform a QueryCard to check your if pushing to or pulling from this card is enabled
Please contact [email protected] if you need a change to your configurations.
423 Locked The Resource pointed to by the ResourceID is locked. Causes include:
  • The ClientId Locked.
Please contact [email protected] for more information as to why your Client account might be locked.
429 Too Many Requests 429 Causes Include:
  • Polling. Please do not poll.
  • Rate Limiting. Reduce the rate at which you send requests.
  • Over your Daily (24-hour rolling) Limit
431 Request Header Fields Too Large Too many HTTP Header Lines and/or HTTP Header Lines too big. Please correct your HTTP Header Lines.
500 Server Error 500 Causes include:
  • There was a problem processing the Request. Response Body will be in JSON format.
  • The IP Address is not allowed. Response Body will be in XML format
Please contact [email protected] for any 5XX errors you experience.
502 Bad Gateway Problem connecting to an Application Server.

Please contact [email protected] for any 5XX errors you experience.
503 Service Unavailable Your request cannot be processed, should be only a Temporary Condition.

Please contact [email protected] for any 5XX errors you experience.
504 Gateway Timeout Connection to an Application Server timed out.

Please contact [email protected] for any 5XX errors you experience.