Errors

Endpoints will return an array of standardized error objects on failures.

We attempt to keep these errors as consistent as possible, and will announce any changes in advance if they are required.

Error Response

Template

[
  {
    "code": string,
    "location": string,
    "message": string,
    "debug_uuid": string
  }
]

Example

[
  {
    "code": "invalid",
    "location": "order.amount.amount_in_cents",
    "message": "Order amount must be greater than $35",
    "debug_uuid": "919f40d0-874b-4d98-810d-ed2246a8ad77"
  }
]

Options

code · string

Error code

location · string

Where the error occurred

message · string

Message describing why error occured

uuid · string

UUID identifying error