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. Examples:
  1. If you get a 207 during a CreateTransaction request, this means the status of the transaction is unknown.
  2. QueryOFAC would return a 207 if the request was unable to reach WatchDog.
If you receive a 207 while using any resource, please contact [email protected] for assistance.
400 Bad Request The ResourceID is invalid
or
The Request Data is invalid. Example: one or more body parameters of your CreateTransaction request are incorrect (e.g. too long, wrong format, json is not properly packed, etc.).
401 UnAuthorized The Authorization Token is invalid Make sure you are using the correct bearer token, or contact [email protected] for assistance.
or
The IP Address is invalid (not whitelisted). Make sure your server’s IP addresses have been whitelisted. For more information contact [email protected].
403 Forbidden Invalid permissions to access the Resource. This resource has not been enabled for your account. Please contact [email protected] for assistance.
404 Not Found The ResourceID does not point to a valid Resource. Example: RetrieveClient would return a 404 if we do not have a Client that matches the ClientId you used. You will want to make sure you are using the correct ClientId .
.405 Method Not Allowed Request Method Not Allowed for the Requested Resource. Example: Card API does not accept GET Requests. 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. Example: invalid characters or json formatting.
409 Conflict ReferenceID already used Example: If you are using RejectDuplicateCard when creating Accounts you would receive a 409 if we detect a duplicate.
or
Conflicting Request Parameters.
410 Gone The Resource pointed to by the ResourceID has been marked for deletion. Example: DeleteKey would return a 410 if the Key you are trying to delete is already marked for deletion. You do not need to continue attempting to delete this Key.
415 Unsupported Media Type Content-type must be application/json.
421 Misdirected Request Too late to Retrieve by ReferenceID, use AccountID or TransactionID. Please use the AccountID or TransactionID with your request.
422 Unprocessable Entity The Resource pointed to by the ResourceID is in an invalid state
or
Create Transaction: The Transaction Amount exceeded one or more Limits. This could also mean that the card you are trying to use is not enabled for the type of transaction (push or pull). You can use our CardQuery API to check what types of transaction that card is enabled for.
423 Locked The Resource pointed to by the ResourceID is locked. Example: RetrieveClient would return a 423 if the Client that matches the ClientId you used is locked. Please contact [email protected] for more information as to why your Client account might be locked.
429 Too Many Requests Retrieve: Too many requests, please do not poll. Example: If you get a `429` response code that means that you are sending too many requests. Reduce the rate at which you send requests.
Create Transaction: Over your Daily (24-hour rolling) Approximation 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 There was a problem processing the Request. 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.