Skip to main content
RoadmapStatusChangelogStart Building Now

Overview


The Unit API uses standard HTTP Status Codes to communicate whether a request has been successfully processed or not. A request may stop processing as soon as a problem is encountered, or it may continue processing and encounter multiple errors. More than one schema validation issues will usually yield multiple errors, while server processing issues will yield a single error. In either case, the response will contain all available errors.

An "error object" MUST contain an HTTP status code member, and MAY also contain one or more of the following:

  1. code:: A Unit-specific underscore separated error code, uniquely identifying the error reported. See list below for currently available error codes.

  2. detail: A descriptive text containing further information about the specific occurrence of the error. The content of this field may change from time to time.

  3. meta: A meta object that contains name/value pairs related to the error.

  4. meta.supportId: A unique error identifier to be used for further investigation.


Error Codes and Their Meaning

feature_disabled ​

400  

The feature that you are trying to use must be manually enabled for you by Unit. Please contact Unit for further assistance.

invalid_value ​

400  

This is one of the most common errors and can occur in various situations when a request is well formed but the input value of one of the fields is incorrect. For example: Date of birth is in the future, input that does not match an expected pattern, invalid tokens, unsupported payment amount etc.

limits_exceeded ​

400  

The request cannot be completed because a limit has been exceeded. This could occur either when making a payment or when setting limits.

not_found ​

400  

The request resource does not exist.

This error might return as is, or preceded with the missing resource, in this manner: {{resource name}}_not_found. For example:

  • account_not_found
  • card_not_found
  • customer_not_found
  • document_not_found
  • pin_not_found
  • routing_number_not_found
  • user_not_found

account_customer_mismatch​

 400 - The specified account is not owned by the specified customer.

not_supported_for_account_status ​

400  

The action is not supported for the account's current status.

not_supported_for_account_type ​

400  

The action is not supported for this type of accounts.

not_supported_for_card ​

400  

This action is not supported for the card. See message for further details.

not_supported_for_card_status ​

400  

This action is not supported in the card's current status.

not_supported_for_card_type ​

400  

This action is not supported for cards of this type.

invalid_nonce ​

400  

The nonce is either malformed or invalid in for use. Please check your input and try again.

not_supported_for_payment_type ​

400  

This action is not supported for payments of this type.

not_supported_for_stop_payment_status ​

400  

Disabled stop payments cannot be updated.

not_supported_for_stop_payment_type ​

400  

The requested operation is not supported for the specified stop payment type. Example: Updating the expiration date is not available for checkStopPayment .

payment_invalid ​

400  

Payment cannot be created with the provided settings (for example: trying to make a payment to the originating account). Please check your request and try again.

unauthorized ​

401  

Bearer token is invalid, missing or has expired.

forbidden ​

403   Action cannot be completed because the requester is not allowed to make the action requested (the bearer token used is of the wrong type, it is missing a required scope, the user role is of the wrong type or the source IP address is not found in the token's source IPs whitelist).

already_exists ​

409  

The result of the action that you are trying to perform or the resource you are trying to create or change, already exists (archiving an already archived customer create an application for a customer that already exists in the system etc.).

customer_name_undeliverable ​

422  

The check payment origination failed because the name of the customer exceeds the limit of 50 characters for allowed for mail items.

customer_address_undeliverable ​

422  

The check payment origination failed because the address of the customer cannot be used as a mailing address. See Check Payment Counterparty for mailing address requirements.

counterparty_address_exceeds_max_length ​

422  

The check payment origination failed because the counterparty address could not be used as a mailing address. While the address input was valid, once standardized, the address exceeded the character limit allowed on a check.