Pix2DePix API
  1. 🛡️ Security & Limits
Pix2DePix API
  • 📜 API Overview
  • Docs
    • 🔑 Authentication
    • 💻 Examples
    • 🪝 Webhook
    • 🛡️ Security & Limits
      • ✅ Best Practices
      • 🧱 Firewall
      • 🪲 Bug Bounty
      • 🚦 API Limits
    • 🧩 Advanced (optional)
      • 🎲 Nonce
      • 🔀 Sync / Async call
  • API Endpoints
    • Ping
      GET
    • Deposit (PIX ➔ DePix)
      POST
    • Deposit Status
      GET
  1. 🛡️ Security & Limits

🚦 API Limits

Current API Limits#

API EndpointRate Limit per MinuteBurst LimitRate Limit per DayNotes
Ping111440The usage limit is low for testing purposes, allowing testing of limit overflow behavior.
Deposit (PIX ➔ DePix)2302880Low limit due to restrictions imposed by the Central Bank. Contact support for adjustments.
Deposit Status602086400-

Rate Limiting#

To ensure fair usage and maintain the stability of our API, rate limiting is applied to certain endpoints. Rate limiting controls how many requests a user can make within a specific time frame. The limits are defined by two key parameters:
Rate Limit: The average number of requests allowed per unit of time (e.g., 1 request per minute).
Burst Limit: The maximum number of requests allowed in a short burst, even if they occur within a shorter time frame than the rate limit.

Explanation#

Rate Limit: This defines the sustained rate at which you can make requests. For example, if the rate limit is set to 1 request per minute, you can make 1 request every minute on average. If you exceed this limit, additional requests will be rejected until the specified time window resets.
Burst Limit: This allows for short bursts of requests above the sustained rate limit. For example, with a burst limit of 5 requests, you can make up to 5 requests in quick succession, even if they occur within the same minute. However, once the burst limit is reached, you must wait for the rate limit to reset before making additional requests.

Example Scenario#

If the rate limit is 1 request per minute and the burst limit is 5 requests, you can:
1.
Send 5 requests in quick succession (burst).
2.
After the 5th request, you must wait for 1 minute before sending another request.
3.
If you attempt to send more than 5 requests within a minute, the API will reject the additional requests until the rate limit resets.

Handling Rate Limits#

If you exceed the rate limit, the API will return an error. To avoid hitting these limits:
Space out your requests to stay within the sustained rate limit.
Monitor your usage and adjust your application's behavior accordingly.
If your application requires higher limits, contact our support team to discuss your needs.
By adhering to these limits, you help ensure a reliable and consistent experience for all users of the API.
Modified at 2025-01-26 19:39:59
Previous
🪲 Bug Bounty
Next
🎲 Nonce
Built with