Stater Platform

Limites de pagamento

GET /accounts/:id/limits — limites diurno/noturno e consumo da janela.

Limites de pagamento

Limites configurados na conta e o consumo da janela atual. spendableNowCents indica quanto pode ser enviado neste momento, considerando o teto vigente (diurno ou noturno).

GET/accounts/:accountId/limits

A janela noturna (night) só aparece preenchida entre 20:00 e 06:00 (horário de Brasília). Fora desse intervalo, night vem como null e o teto vigente é o de daily. Valores em centavos como string (diferente de /accounts/:id que usa reais decimal — esta diferença é por compatibilidade com a API Pix subjacente).

Path params

  • accountIdObrigatório
    string (UUID)
    ID da conta.

Headers

  • AcceptObrigatório
    string
    application/json
  • AuthorizationObrigatório
    string
    Bearer <token> — JWT de /authenticate.
  • X-Tenant-IdObrigatório
    string (UUID)
    Identificador do tenant.

Exemplo de requisição

bash
curl https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/limits \  -H "Accept: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"

Resposta

  • perTransactionCents
    string
    Teto por transação Pix (centavos).
  • dailyCents
    string
    Teto da janela diária (centavos).
  • nightCents
    string
    Teto da janela noturna (centavos).
  • daily
    object
    Janela diária ativa: { windowStart, windowEnd, consumedCents, remainingCents }.
  • night
    object | null
    Mesma estrutura de daily quando a janela noturna está ativa (a partir das 20:00 BRT). null fora dela.
  • spendableNowCents
    string
    Quanto pode ser enviado agora (centavos).
json
{  "perTransactionCents": "100000",  "dailyCents": "100001",  "nightCents": "100000",  "daily": {    "windowStart": "2026-05-13T06:00:00.000-03:00",    "windowEnd": "2026-05-14T06:00:00.000-03:00",    "consumedCents": "0",    "remainingCents": "100001"  },  "night": null,  "spendableNowCents": "100001"}
URL base:https://baas.staterpay.io

On this page