DEVELOPERS · API v1

Errors and limits

Public documentation. Partner access through Sales.

Contact Sales

Documentation / Errors and limits

Send Accept: application/json on all requests. Inspect both the HTTP status and response body; validation errors use the framework validation format.

Partner error

{"error":{"code":"idempotency_conflict","message":"Idempotency key already used for a different request."},"meta":{"request_id":null}}

Validation error

{"message":"The name field is required.","errors":{"name":["The name field is required."]}}

HTTP status reference

HTTP statusError codeWhat to do
400invalid_request / invalid_scopeCheck the key header or requested scopes.
401invalid_client / invalid_tokenCheck credentials or renew the token.
403insufficient_scope / ip_not_allowed / environment_unavailable / loyalty_rejectedCheck access, IP restrictions and merchant status.
404not_foundCheck the resource identifier and client ownership.
409idempotency_conflict / redemption_conflictResolve the conflicting request or reference.
422validation / validation_failedCorrect fields or check reward and stamp balances.
429rate limitWait for Retry-After before retrying.
500server errorRetry safely using the same operation key.

Rate limits

Partner requests are limited to 120 per minute per client. Token requests are limited to 20 per minute per IP. Rate-limited responses include Retry-After. These are current defaults; discuss expected volume with Sales.

Error format boundaries

Not every failure uses the partner envelope. Authentication, authorization and controller errors may differ from framework validation, throttling and server errors. request_id may be null; do not rely on it being present for tracing.

Your privacy

We use necessary storage for sign-in, security and preferences. No analytics or advertising trackers are enabled.

Necessary storage Always active
Keeps your session secure, remembers your language and stores your privacy choice.
Analytics and advertising
Not enabled. We do not use session replay or advertising cookies in this version.

This choice does not accept subscription terms or sign you up for marketing emails.

Legal and privacy centre