Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-test.rye.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Our API uses standard HTTP status codes to indicate the success or failure of a request. When an error occurs, the response will include an error code and message. Your integration should handle these gracefully, with retry logic where appropriate, and surface clear messages to users when action is required.
Status CodeMessageHow to Resolve
400Bad RequestCheck your request payload and parameters for missing or invalid fields.
401UnauthorizedEnsure you are using the correct API key.
403ForbiddenYour API key does not have permission. Confirm access rights or contact support.
404Not FoundVerify the endpoint URL and resource ID.
409ConflictThe resource is in an invalid state (e.g., duplicate request). Retry if safe.
422Unprocessable EntityInput validation failed. Check field formats and required attributes.
429Too Many RequestsYou have exceeded the rate limit. See Rate Limits for limits, headers, and retry guidance.
500Internal Server ErrorTemporary server issue. Retry the request or contact support if persistent.
503Service UnavailableAPI is temporarily unavailable. Retry with backoff.
Specific Error Cases
  • A 404 error can occur if an order confirmation request is submitted before the order reaches awaiting_confirmation. Adding a short delay or polling until the order is ready will help prevent this error.
  • When creating a checkout intent, the buyer.country field is case sensitive. The expected input is uppercase.
  • If you get an Order Failed: No such token error, confirm that you are generating the card token with the Rye publishable key, rather than your own Stripe key.
  • constraint_total_price_exceeded and constraint_shipping_cost_exceeded are returned when the order total or shipping cost exceeds the value specified in the checkout request.
  • If you get the error The specified phone number does not match the expected pattern, please update the phone number in your request to use the format 010-010-0101.