Errors

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

Status Codes

400

Backend Error

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

Default message: backend error

Bad Request

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

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.

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).

Default message: documents list cannot be modified

Expired Charge

An attempt was made to capture a charge, but the charge can no longer be captured. An authorized charge left uncaptured for more than 7 days (the exact duration depends on card issuing bank) will automatically be canceled.

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.

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.

Default message: expire 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.

Default message: the currency conversion could not be completed

Failed Refund

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

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.

Default message: reverse failed

Failed Void

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

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.

Default message: feature not supported

Invalid Amount

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

Default message: invalid amount

Invalid Bank Account

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

Default message: invalid bank account

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.

Default message: invalid card token

Invalid Card

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

Default message: invalid card

Invalid Charge

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

Default message: invalid charge

Invalid Dispute

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

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.

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.

Default message: invalid content-type

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

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.

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.

Default message: invalid transfer

Missing Card

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

Default message: request contains no card parameters

Missing File

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

Default message: missing file or filename

Processed Charge

An attempt was made to process an offline charge, but the charge was already processed.

Default message: charge was already processed

Used Token

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

Default message: token was already used


401

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.

Default message: authentication failed


403

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.

Default message: expired key

Locked Account Error

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

Default message: account locked

Not Authorized

An attempt was made to perform an unauthorized action.

Default message: not authorized


404

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.

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.

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.

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


422

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.

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.

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.

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.

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.

Default message: invalid scope


500

Internal Error

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

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


503

Search Unavailable

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

Default message: search is temporarily unavailable