Quickstart

Em menos de cinco minutos você terá feito a primeira requisição autenticada à Stater Platform.

1. Obtenha sua API key

No painel da Stater, gere uma API key da sua conta. Trate-a como um segredo: nunca exponha no front-end e nunca commite no repositório.

2. Faça a primeira chamada

Vamos consultar os dados da sua conta com GET /v1/account. Substitua SUA_API_KEY pelo valor real:

curl https://api.staterpay.io/v1/account \-H "Authorization: Bearer SUA_API_KEY"

3. Resposta esperada

{"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"}

label é o documento (CNPJ) da conta; branchIdentifier e accountNumber identificam a agência e conta interna; os campos limit*Cents e *FeeCents/*FeeBps trazem limites e tarifas configuradas. Valores monetários sempre em centavos como string.

Próximos passos

• Aprenda sobre autenticação.
• Implemente o fluxo de envio de Pix.
• Crie cobranças seguindo o guia de recebimento.