API Errors
HTTP Codes
Copper uses conventional HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a transaction failed, etc.). Codes in the 5xx range indicate an error with Coppers's servers (these are rare).
Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.
Attributes
The following table lists error attributes one can expect from errors returned by the API.
| Name | Type | Description |
|---|---|---|
type |
string | The type of error returned. |
code |
string | For some errors that could be handled programmatically, a short string indicating the error code reported. |
message |
string | A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. |
param |
string | If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. |