Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xpaycheckout.com/llms.txt

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

xPay employs sophisticated rate limiting mechanisms to ensure optimal API performance and equitable resource distribution across all merchants. Our rate limiting system orchestrates request throughput to maintain peak performance and prevent system overload, encompassing all API endpoints within your merchant account. When you exceed these thresholds, you’ll encounter error responses with status code 429. Each API request consumes quota from your allocated allowance.

​
Quotas

Our throttling system enforces the following request quotas per minute:
  • Live mode: 10 requests per second
  • Sandbox: 10 requests per second
These quotas encompass all API endpoints within your merchant account. Every API call consumes quota from your allocated allowance.
Avoid polling - Polling APIs repeatedly to check for status changes is strictly discouraged and will rapidly exhaust your rate limits.Use Webhooks Instead: For real-time status updates, utilize webhooks instead of polling. Webhooks provide instantaneous notifications when status changes occur, eliminating the necessity for repeated API calls.For webhook implementation details, see Webhooks.
Anticipate traffic surges: Proactively plan for high-volume events by contacting xPay support at hello@xpaycheckout.com to discuss your expected traffic patterns and ensure your integration can handle the load.

​
Response

When you exceed the throttling threshold, requests return a 429 Too Many Requests status code:
HTTP Status Code: 429
{
  "errorCode": "rate_limit_exceeded",
  "errorDescription": "Too many requests. Please slow down your request rate."
}