Learn how the Loopz Gift Cards API returns errors and how to handle them.
Loopz' API 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 charge failed, etc.). Codes in the 5xx
range indicate an error with Loopz' 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.
Error Response Attributes
code number
The error code of the error response. Check the Error Codes table for a detailed description of the returned error code.
message string
A descriptive message of the error that occurred.
locale string
The locale of the error message.
fields array
An array of key value pairs where the key references the parameter that caused the error and the value is a descriptive error message.
HTTP Status Codes | Description |
---|---|
200 - OK | Everything worked as expected. |
400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 - Unauthorized | No valid API key provided. |
403 - Forbidden | The API key doesn't have permissions to perform the request. |
404 - Not Found | The requested resource doesn't exist. |
409 - Conflict | The request conflicts with another request (perhaps due to using the same idempotent key). |
429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. Up to 250 requests per API key per minute are allowed. |
5** - Server Error | Something went wrong on Loopz' end. (Contact support or check our status page.) |