For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
LogoLogo
StatusDashboard
On this page
  • Rate Limits
  • Default Limits
  • Exceeding the Limit
  • Example Response
  • Best Practices
  • Requesting Higher Limits
Getting Started

Rate Limits

Was this page helpful?
Edit this page
Previous

Error Handling

Next
Built with

Rate Limits

The BRZ API enforces rate limits to ensure fair usage and system stability.

Default Limits

MetricLimit
Sustained rate50 requests/second per client
Burst rateUp to 100 requests/second

Exceeding the Limit

When you exceed the rate limit, the API returns:

  • HTTP Status: 429 Too Many Requests
  • Header: Retry-After — indicates how many seconds to wait before retrying

Example Response

1{
2 "error": "Rate limit exceeded",
3 "code": "RATE_LIMIT_EXCEEDED",
4 "retry_after": 5
5}

Best Practices

  1. Implement exponential backoff: When receiving a 429 response, wait for the duration specified in the Retry-After header before retrying.
  2. Use idempotency keys: Include the X-Idempotency-Key header in POST requests to safely retry without creating duplicate operations.
  3. Batch operations: Where possible, batch multiple operations into fewer API calls.
  4. Cache responses: Cache responses for read operations (e.g., balance checks, key lookups) to reduce unnecessary API calls.
  5. Monitor usage: Track your API usage patterns to stay within limits.

Requesting Higher Limits

If your use case requires higher rate limits, contact the BRZ support team to discuss custom limits for your account.