Errors

Topics covered on this page

Errors returned from the API. See Error Object for structure.

Status codes

400 Bad Request

Backend Error

An error occurred communicating with the provider for this particular payment method. Please try again.

error code: backend_error

Default message: backend error

Bad Request

Several types of invalid requests return bad_request. See the message attribute for more information.

error code: bad_request

Default message: bad request

Brand Not Supported

An attempt was made to create a charge using a card with a brand not supported by the account.

error code: brand_not_supported

Default message: brand not supported

Documents Locked

An attempt was made to upload a file to a dispute that is no longer open (status=open).

error code: documents_locked

Default message: documents list cannot be modified

Expired Charge

For credit and debit cards, an attempt was made to capture or reverse a charge, but the charge can no longer be captured. Authorized credit and debit card charges left uncaptured for more than 7 days (30 days for merchants registered in Japan) will automatically be canceled.

For other payment methods, an attempt was made to complete a charge (for example, in-person payment using a payment code generated by Omise), but the expiration date for the charge has already passed.

error code: expired_charge

Default message: charge expired

Failed Capture

An attempt was made to capture a charge, but the charge was not captured. The charge might not be authorized yet, or it might have already been captured. The specific reason can be found in the message attribute.

error code: failed_capture

Default message: capture failed

Failed Expire

An attempt was made to set a charge to expire, but the charge could not be set to expire.

error code: failed_expire

Default message: expire failed

Failed Fraud Check

An attempt was made to create a token, but card was marked as fraudulent.

error code: failed_fraud_check

Default message: fraud check failed

Failed Multi Currency

An attempt was made to create a multi-currency charge, but failed. Please contact support@omise.co to enable multi-currency.

error code: failed_multi_currency

Default message: the currency conversion could not be completed

Failed Refund

An attempt was made to process a refund but something went wrong.

error code: failed_refund

Default message: refund failed

Failed Reverse

An attempt was made to reverse a charge, but the charge was not reversed. See the message attribute for more information.

error code: failed_reverse

Default message: reverse failed

Failed Void

An attempt was made to void (e.g. refund) a charge, but the charge was not voided.

error code: failed_void

Default message: void failed

Feature Not Supported

An attempt was made to use a feature which is not currently enabled for your account. Please contact support@omise.co.

error code: feature_not_supported

Default message: feature not supported

Invalid Amount

An attempt was made to create a charge with a non-integer amount.

error code: invalid_amount

Default message: invalid amount

Invalid Bank Account

An attempt was made to create a recipient with an invalid bank account. See Supported Banks.

error code: invalid_bank_account

Default message: invalid bank account

Invalid Card

An attempt was made to create a token with invalid parameters.

error code: invalid_card

Default message: invalid card

Invalid Card Token

An attempt was made to perform an action which requires a card token string (e.g. tokn_test_4xvpea0ifwajbx3f873) using a non-string object (for example, a card dictionary) instead.

error code: invalid_card_token

Default message: invalid card token

Invalid Charge

An attempt was made to create a charge that does not meet the minimum requirements. See the message attribute for more information.

error code: invalid_charge

Default message: invalid charge

Invalid Dispute

An attempt was made to modify a dispute outside of the allowed parameters.

error code: invalid_dispute

Default message: invalid dispute

Invalid Domain

An attempt was made to generate a token using the api.omise.co domain. Use vault.omise.co to generate tokens.

error code: invalid_domain

Default message: request must be made with the http://vault.omise.co domain

Invalid File Type

An attempt was made to upload a file with a type outside of the allowed file types. See Documents API for supported file types.

error code: invalid_file_type

Default message: invalid content-type

An attempt was made to create a link with an invalid currency or with no description parameter.

error code: invalid_link

Default message: invalid link

Invalid Recipient

An attempt was made to update a recipient in an invalid way (e.g. deleting a recipient that cannot be deleted) or send a transfer to a recipient who doesn't exist.

error code: invalid_recipient

Default message: invalid recipient

Invalid Transfer

An attempt was made to create or update a transfer in an invalid way (e.g. deleting a transfer that cannot be deleted, transferring more than the available balance, or transferring to an inactive recipient). The specific reason can be found in the message attribute.

error code: invalid_transfer

Default message: invalid transfer

Missing Card

An attempt was made to create a token with invalid card parameters.

error code: missing_card

Default message: request contains no card parameters

Missing File

An attempt was made to upload a non-existent file.

error code: missing_file

Default message: missing file or filename

Used Token

An attempt was made to re-use a token. Tokens are single use only.

error code: used_token

Default message: token was already used


401 Unauthorized

Authentication Failure

An attempt was made to access the API using an invalid key. Check whether the API method accepts a private or public key. Current keys can be found in the account dashboard.

error code: authentication_failure

Default message: authentication failed


403 Forbidden

Key Expired Error

An attempt was made to perform a request using an expired (i.e. revoked) key. Current keys can be found in the account dashboard.

error code: key_expired_error

Default message: expired key

Locked Account Error

The account is locked. Please contact support@omise.co.

error code: locked_account_error

Default message: account locked

Not Authorized

An attempt was made to perform an unauthorized action.

error code: not_authorized

Default message: not authorized


404 Not Found

Not Found

An attempt was made to reference an object ID (e.g. rfnd_test_5dvfvd32uiabudlr3v7) that could not be found. Check that you’re using the right ID for the right request.

error code: not_found

Default message: the requested object was not found

Serializer Not Found

An attempt was made to use a feature which is not supported by the API version of the request. If the API version is not specified in the header of the request (e.g. Omise-Version: 2017-11-02), the API version of the account is used by default. Learn how to update API versions here.

error code: serializer_not_found

Default message: your current API version does not support this action

Service Not Found

An attempt was made to use a feature which is not supported by the API version of the request. If the API version is not specified in the header of the request (e.g. Omise-Version: 2017-11-02), the API version of the account is used by default. Learn how to update API versions here.

error code: service_not_found

Default message: you are using api version which does not support this operation


422 Unprocessable Entity

Failed Deletion

An attempt was made to delete an object (e.g. a link or a schedule), but the operation failed. See the message attribute for more information.

error code: failed_deletion

Default message: this object could not be deleted

Invalid Filter

An invalid key was passed to the search filters parameter. Search requests expect specific set of filter keys. See list of available filters.

error code: invalid_filter

Default message: invalid filters

Invalid Page

An invalid number was passed to the search page parameter. Search requests expect positive integers in the page parameter.

error code: invalid_page

Default message: invalid page

Invalid Per Page

An invalid number was passed to the search per_page parameter. Search requests expect positive integers in the per_page parameter.

error code: invalid_per_page

Default message: invalid per page

Invalid Scope

An invalid (or missing) string was passed to the search scope parameter. Search requests expect a scope to be one a predefined list of scopes. See list of available scopes.

error code: invalid_scope

Default message: invalid scope


429 Too Many Requests

Too Many Requests

An attempt was made to send too many requests in too little time. See guidance on request rate limiting.

error code: too_many_requests

Default message: you have sent too many requests in too little time


500 Internal Server Error

Internal Error

An internal server error occurred. If this error occurs again, please contact support@omise.co.

error code: internal_error

Default message: request could not be completed due to an internal error


503 Service Unavailable

Search Unavailable

An attempt was made to search, but the Search API is temporarily unavailable. Please try again.

error code: search_unavailable

Default message: search is temporarily unavailable


Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more