Stater Platform
API Reference

Tarifas da conta

Tarifas Pix in/out, com componentes fixo e percentual em basis points.

Tarifas da conta

Tarifas Pix e TEV (in/out) aplicadas à conta. Cada tarifa tem um componente fixo (*FeeCents) e um percentual em basis points (*FeeBps; 100 = 1%).

GET/v1/pix-accounts/:accountId/fees

Path params

  • accountIdObrigatório
    string
    ID da conta Pix.

Headers

  • AuthorizationObrigatório
    string
    Bearer SUA_API_KEY
  • X-Pix-Account-Id
    string
    Seleciona a conta quando a chave tem acesso a várias.

Exemplo de requisição

bash
curl https://api.staterpay.io/v1/pix-accounts/cmoxample0001qkxyzaccount/fees \  -H "Authorization: Bearer SUA_API_KEY"

Resposta

  • pixInFeeCents
    string
    Tarifa fixa em centavos para Pix recebido.
  • pixInFeeBps
    number
    Percentual em basis points para Pix recebido.
  • pixOutFeeCents
    string
    Tarifa fixa em centavos para Pix enviado.
  • pixOutFeeBps
    number
    Percentual em basis points para Pix enviado.
  • tevInFeeCents
    string
    Tarifa fixa em centavos para TEV recebida.
  • tevInFeeBps
    number
    Percentual em basis points para TEV recebida.
  • tevOutFeeCents
    string
    Tarifa fixa em centavos para TEV enviada.
  • tevOutFeeBps
    number
    Percentual em basis points para TEV enviada.
  • updatedAt
    string (ISO-8601)
    Última atualização da configuração de tarifas.
json
{  "pixInFeeCents": "0",  "pixInFeeBps": 0,  "pixOutFeeCents": "0",  "pixOutFeeBps": 0,  "tevInFeeCents": "0",  "tevInFeeBps": 0,  "tevOutFeeCents": "0",  "tevOutFeeBps": 0,  "updatedAt": "2026-05-04T10:26:23.895-03:00"}
URL base:https://api.staterpay.io

Chaves Pix da conta

Lista as chaves Pix cadastradas na conta.

Criar cobrança Pix

POST /v1/charges — gera QR Code Pix com TXID único.

On this page

Path paramsHeadersExemplo de requisiçãoResposta