API Reference
Referência da API
Visão geral dos endpoints — conta, cobranças, payouts, DICT, QR Code e webhooks.
Todas as operações da Stater estão sob a base https://api.staterpay.io e exigem autenticação Bearer.
38
Endpoints
7
Recursos
8
Eventos
v1
Versão
Convenções
- JSON em request e response.
- Valores monetários em centavos como string.
- Datas em ISO-8601 — UTC nos campos de entrada, UTC-3 (Brasília) nos retornos.
- Paginação por cursor (
cursor+limit) onde aplicável. - Header
Idempotency-Keyobrigatório em escritas.
Recursos
Account5 endpoints
Dados da conta, limites, tarifas e chaves Pix.
Cobranças4 endpoints
Criar, listar, consultar e re-sincronizar cobranças.
DICT1 endpoint
Consulta de titular pela chave Pix.
Movimentos4 endpoints
Extrato, saldo e detalhes de movimento.
Transferências Pix4 endpoints
Payouts via chave, listagem e consulta.
Pagar QR Code2 endpoints
Decodificar e pagar QR Codes Pix.
Webhooks4 endpoints
Gestão de endpoints de notificação.