API Reference
Dados da conta
GET /v1/account — retorna a conta resolvida pela API key.
Dados da sua conta
Retorna a conta Pix resolvida pela API key (ou pelo header X-Pix-Account-Id quando informado). Inclui identificadores, tarifas e limites configurados.
GET/v1/account
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/account \ -H "Authorization: Bearer SUA_API_KEY"Resposta
- idstringIdentificador da conta Pix (cuid).
- tenantIdstring (UUID)Tenant proprietário da conta.
- branchIdentifierstringIdentificador da agência interna.
- accountNumberstringNúmero da conta interna.
- coreAccountIdstringID da conta no core bancário.
- labelstringDocumento (CPF/CNPJ) associado à conta — apenas dígitos.
- enabledbooleanSe a conta está ativa para operações Pix.
- pixInFeeCentsstringTarifa fixa em centavos para Pix recebido.
- pixInFeeBpsnumberTarifa percentual em basis points para Pix recebido (1 bps = 0,01%).
- pixOutFeeCentsstringTarifa fixa em centavos para Pix enviado.
- pixOutFeeBpsnumberTarifa percentual em basis points para Pix enviado.
- limitPerTransactionCentsstringTeto por transação (centavos).
- limitDailyCentsstringTeto da janela diária (centavos).
- limitNightCentsstringTeto da janela noturna (centavos, 20:00–06:00 BRT).
- createdAtstring (ISO-8601)Criação da conta.
- updatedAtstring (ISO-8601)Última atualização.
json
{ "id": "cmoxample0001qkxyzaccount", "tenantId": "00000000-0000-0000-0000-000000000000", "branchIdentifier": "1", "accountNumber": "123456", "coreAccountId": "cmoxample0001qkxyzcoreaccount", "label": "12345678000190", "enabled": true, "pixInFeeCents": "0", "pixInFeeBps": 0, "pixOutFeeCents": "0", "pixOutFeeBps": 0, "limitPerTransactionCents": "1000000", "limitDailyCents": "1000000", "limitNightCents": "500000", "createdAt": "2026-05-04T10:26:23.895-03:00", "updatedAt": "2026-05-04T10:26:23.895-03:00"}URL base:
https://api.staterpay.io