Errors

Column attempts to handle all errors and mistakes as gracefully and with as much detail as posssible.

HTTP Error Codes

We use HTTP codes to group errors.

Status Code	Description
`200`	OK. Your request worked as expected successfully.
`400`	Bad Request. Your request failed due to the information in the request or situational reasons (e.g. an insufficient balance or a validation error on the request).
`401`	Unauthorized. No valid API key or session token provided.
`403`	Forbidden. You don't have permission to perform the request.
`404`	Not Found. The requested resource does not exist.
`429`	Too Many Requests. Too many requests hit the API too quickly.
`5xx`	Something went wrong in Column's systems (extremely rare). You should assume that we are being paged for all `5xx` errors.

Error Attributes

There are five fields that are returned in error response bodies.

Attribute	Description
`type`	The overarching category of the error.
`code`	The specific error. It is a short string that you can handle programmatically if you choose.
`message`	A human readable error message meant to be read by a developer, not an end consumer. `message` will change and should not be used programatically. If you want consumer-friendly error messaging, we recommend you map off of `code`.
`documentation_url`	A link to the most appropriate API doc for this error. This should be considered a guide.
`details`	An object with key-value pairs that may provide more details about the error. For example, a parameter validation error will have the list of parameters that are invalid with reasons. In some cases, `details` may be an empty object.

The following is an example of bank account not found errors:

{
  "type": "bank_account_error",
  "code": "bank_account_not_found",
  "message": "Bank account does not exist on this platform.",
  "documentation_url": "https://column.com/docs/api/#bank-account/create",
  "details": null
}

Error Types

Error type	Description
`authentication_error`	Issues related to API authentication. Usually related to API key validity, user permissions, etc.
`bank_account_error`	Issues related to bank accounts.
`dashboard_error`	Issues related to dashboard operations.
`entity_error`	Issues related to entities, KYC/KYB, etc.
`limit_error`	Issues related to limit controls.
`loan_error`	Issues related to loans .
`request_validation_error`	Issues related to request schema. Usually you're missing a parameter, a value is incorrect, or we cannot parse or process the request.
`server_error`	Issues related to Column's systems. We'll be notified for all of these errors.
`transfer_error`	Issues related to transfers.

Error Codes

Work In Progress

Not all of our error codes are listed below yet, as we are still working on this page. We will complete the list of all error codes soon.

fx_quote_book_failed
Failed to book foreign exchange rate quote. This is a generic code for FX quote booking related errors that do not have their specific codes yet. You should assume that we will add additional error codes for them soon.

fx_quote_cancel_failed
Failed to cancel foreign exchange rate quote. This is a generic code for FX quote canceling related errors that do not have their specific codes yet. You should assume that we will add additional error codes for them soon.

fx_quote_different_amount
The buy amount and currency of a foreign exchange rate quote is different from the amount and currency of its corresponding outgoing transfer.

fx_quote_expired
The foreign exchange rate quote has expired. You need to book a new quote for your outgoing transfer.

fx_quote_query_failed
Failed to query foreign exchange rate quote. This is a generic code for FX quote querying related errors that do not have their specific codes yet. You should assume that we will add additional error codes for them soon.

fx_quote_rate_date_cutoff_missed
You missed the cut-off for the given foreign exchange rate date. Please use the next business day.

fx_quote_rate_date_too_far
The foreign exchange rate date is beyond the maximum allowed date in future. Please use a closer business day. Please refer to details.max_rate_date for more information.

fx_quote_reuse
The foreign exchange rate quote has already been used, canceled or failed. You need to book a new quote for your outgoing transfer.

invalid_charge_bearer
You specified an invalid charge bearer code in your request. Read more.