Skip to main content

Responses and errors

Successful calls return the endpoint response directly as JSON.

{
"success": true,
"merchant": "Example Coffee"
}

Errors use a consistent JSON shape:

{
"code": 401,
"message": "Invalid API key"
}

Common status codes

StatusMeaning
200The request succeeded.
400A required field is missing or invalid.
401The API key is missing or invalid.
404The merchant, integration, or reward was not found.
500An unexpected server error occurred.

Do not retry 400 or 401 responses without correcting the request. Retry transient 500 responses with exponential backoff and jitter.