Permissões da API key

Cada chave de API carrega um array de permissões no formato recurso/ação. O guard da API bloqueia rotas sem permissão com 403.

Presets

Preset	Inclui
`read`	Apenas permissões de leitura (`get`, `list`, consultas)
`write`	Leitura + criação e atualização
`full`	Todas as permissões abaixo

No dashboard, você pode ajustar permissões manualmente além do preset.

Tabela completa

PIX e conta

Permissão	Tipo	Rota
`payment-pix/create`	write	`POST /payment-pix/create`
`payment-pix/get`	read	`GET /payment-pix/get/:id`
`payment-pix/list`	read	`GET /payment-pix/list`
`transfer-pix/create`	write	`POST /transfer-pix/create`
`transfer-pix/get`	read	`GET /transfer-pix/get/:id`
`transfer-pix/list`	read	`GET /transfer-pix/list`
`payouts/create`	write	`POST /payouts/create` (alias)
`payouts/get`	read	`GET /payouts/get/:id`
`payouts/list`	read	`GET /payouts/list`
`transfer-internal/create`	write	`POST /transfer-internal/create`
`transfer-internal/get`	read	`GET /transfer-internal/get/:id`
`transfer-internal/list`	read	`GET /transfer-internal/list`
`refunds/create`	write	`POST /refunds/create`
`refunds/get`	read	`GET /refunds/get/:id`
`refunds/list`	read	`GET /refunds/list`
`account/balance`	read	`GET /account/balance`
`account/transactions`	read	`GET /account/transactions`

Cripto

Permissão	Rota
`payment-crypto/currencies`	`GET /payment-crypto/currencies`
`payment-crypto/create`	`POST /payment-crypto/create`
`payment-crypto/get`	`GET /payment-crypto/get/:id`
`payment-crypto/list`	`GET /payment-crypto/list`
`transfer-crypto/create`	`POST /transfer-crypto/create`
`transfer-crypto-auto/create`	`POST /transfer-crypto-auto/create`
`transfer-crypto/get`	`GET /transfer-crypto/get/:id`
`transfer-crypto/list`	`GET /transfer-crypto/list`

MED

Permissão	Rota
`meds/list`	`GET /meds/list`
`meds/get`	`GET /meds/get/:id`
`meds/evidence`	`POST /meds/:id/evidence`

Cobranças e assinaturas

Permissão	Rota
`customers/create`	`POST /customers/create`
`customers/get`	`GET /customers/get/:id`
`customers/list`	`GET /customers/list`
`customers/update`	`PATCH /customers/update/:id`
`customers/delete`	`DELETE /customers/delete/:id`
`billings/create`	`POST /billings/create`
`billings/tokenize`	`POST /billings/tokenize-card`
`billings/get`	`GET /billings/get/:id`
`billings/list`	`GET /billings/list`
`billings/refund`	`POST /billings/refund`
`subscriptions/create`	`POST /subscriptions/create`
`subscriptions/get`	`GET /subscriptions/get/:id`
`subscriptions/list`	`GET /subscriptions/list`
`subscriptions/cancel`	`POST /subscriptions/cancel/:id`

Produtos avançados (Conta Padrão)

Visão geral: Produtos avançados.

Permissão	Rota
`pix-automatic/*`	PIX automático
`pix-pay/*`	Pagar QR e transações
`mobile-recharge/*`	Recarga móvel
`serasa/*`	Bureau (negativação e relatórios)

Webhooks e subcontas

Permissão	Rota
`webhooks/create`	`POST /webhooks/create`
`webhooks/list`	`GET /webhooks/list`
`webhooks/get`	`GET /webhooks/get/:id`
`webhooks/update`	`PATCH /webhooks/update/:id`
`webhooks/delete`	`DELETE /webhooks/delete/:id`
`subaccount/*`	Todas as rotas `/subaccount/*`

IP allowlist

Além das permissões, a chave pode restringir IPs (allowAnyIp: false + lista CIDR). Requisições de IP não listado retornam 403.

Próximo passo

Primeira integração

Começar

Integração

Tutoriais

Ajuda

Permissões da API key

Presets

Tabela completa

PIX e conta

Cripto

MED

Cobranças e assinaturas

Produtos avançados (Conta Padrão)

Webhooks e subcontas

IP allowlist

Próximo passo

​Presets

​Tabela completa

​PIX e conta

​Cripto

​MED

​Cobranças e assinaturas

​Produtos avançados (Conta Padrão)

​Webhooks e subcontas

​IP allowlist

​Próximo passo

Presets

Tabela completa

PIX e conta

Cripto

MED

Cobranças e assinaturas

Produtos avançados (Conta Padrão)

Webhooks e subcontas

IP allowlist

Próximo passo