API Reference
Rate limit da conta
Multiplicador e limites efetivos de requisições por rota.
Rate limit
Retorna o multiplicador aplicado à conta, se está bypassada e os limites efetivos de requisições por rota (em chamadas/minuto).
GET/v1/pix-accounts/:accountId/rate-limit
Path params
- accountIdObrigatóriostringID da conta Pix.
Headers
- AuthorizationObrigatóriostringBearer SUA_API_KEY
- X-Pix-Account-IdstringSeleciona a conta quando a chave tem acesso a várias.
Exemplo de requisição
bash
curl https://api.staterpay.io/v1/pix-accounts/cmoxample0001qkxyzaccount/rate-limit \ -H "Authorization: Bearer SUA_API_KEY"Resposta
- multipliernumberFator multiplicativo dos limites. 1 = padrão.
- isBypassbooleanQuando true, a conta não é submetida ao rate limit.
- limitsobjectMapa rota → { maxPerMinute }.
json
{ "multiplier": 1, "isBypass": false, "limits": { "POST /v1/payouts": { "maxPerMinute": 30 }, "POST /v1/payouts/qr-code": { "maxPerMinute": 30 }, "POST /v1/dict/lookup": { "maxPerMinute": 30 }, "POST /v1/qr-code/decode": { "maxPerMinute": 30 }, "POST /v1/charges": { "maxPerMinute": 120 }, "POST /v1/charges/:id/refresh": { "maxPerMinute": 60 }, "GET /v1/charges": { "maxPerMinute": 300 }, "GET /v1/payouts": { "maxPerMinute": 300 }, "GET /v1/inbox": { "maxPerMinute": 300 }, "GET /v1/movements/:id": { "maxPerMinute": 300 }, "GET /v1/movements/:id/full": { "maxPerMinute": 300 }, "GET /v1/statement": { "maxPerMinute": 120 }, "GET /v1/statement/summary": { "maxPerMinute": 120 } }}URL base:
https://api.staterpay.io