API reference · Errors
API reference / Overview
Errors
Errors come back with state: "error". The result says what went wrong, usually as result.reason.
| Status | Meaning |
|---|---|
401 | The key or token is missing, wrong, revoked, for the other environment, or without the scope this endpoint needs. |
402 | Checkout sessions only: the payment was declined at the fraud check, or the merchant can't take payments. |
403 | Some endpoints, such as partner activation and vouching: this credential can't do this. |
404 | The path doesn't exist, or a checkout session wasn't found. |
409 | A conflict, like an idempotency key reused with a different body. |
422 | A field is missing or wrong. result.reason names the fields. |
429 | Only where an endpoint lists it, for example too many verification codes. |
5xx | Something failed at Inkress. Keep the x-request-id. |
Check `state`, not only the status
Fetching an object that doesn't exist answers 200 with state: "ok" and result: false. A few older endpoints answer 200 with state: "error", for example subscriptions that can't be found. Check both.
Request IDs
Every response carries an x-request-id header. Keep it with failed calls; it finds the request in Request logs.