Referência
Escopos OAuth
Cada rota exige um conjunto específico de escopos. Solicite no token apenas o que sua aplicação realmente precisa.
Escopos disponíveis
accounts:readListar/ler contas, saldo, chaves PIX, extrato.accounts:writeCriar contas.ledger:readExtrato detalhado, ledger entries, reconciliação.pix:outPIX saída (payouts), comprovantes.pix:inQR de depósito, consulta de cobrança PIX.webhooks:manageCRUD de webhooks de saída, teste de evento.Mapa de rotas → escopos
| Rota | Escopo |
|---|---|
| GET /v1/accounts | accounts:read |
| POST /v1/accounts | accounts:write |
| GET /v1/accounts/:id | accounts:read |
| GET /v1/accounts/:id/balance | accounts:read |
| GET /v1/accounts/:id/pix-keys | accounts:read |
| GET /v1/accounts/:id/statement | ledger:read |
| GET /v1/accounts/:id/ledger-entries | ledger:read |
| POST /v1/accounts/:id/pix/deposit-qrcodes | pix:in |
| GET /v1/accounts/:id/pix/charges/:chargeId | pix:in |
| POST/GET .../pix/payouts... | pix:out |
| POST /v1/webhook-endpoints (CRUD) | webhooks:manage |