Conceitos
Produtos de integração e escopos
Cada produto reúne escopos e define o que a credencial pode chamar.
Página em construção
Este é um resumo. O conteúdo completo entra nas próximas versões da documentação; o contrato de cada rota já está na Referência da API.
| Produto | Escopos |
|---|---|
platform.core | events:events:read, webhooks:endpoints:read, webhooks:endpoints:write |
payments.pix | payments:pix:read, payments:pix:write |
payments.boleto | payments:boleto:read, payments:boleto:write |
payments.cards | payments:cards:read, payments:cards:write, payments:vault:read, payments:vault:write |
payments.links | payments:links:read, payments:links:write |
payments.customers | payments:customers:read, payments:customers:write |
receivables.balance | receivables:balance:read, receivables:statement:read, receivables:settlements:read |
payouts.withdrawals | payouts:withdrawals:read, payouts:withdrawals:write, payouts:destinations:read, payouts:destinations:write |
contracts.signatures | contracts:contracts:read, contracts:contracts:write, contracts:templates:read, contracts:templates:write |
payments.deposits | payments:deposits:read, payments:deposits:write |
fx.exchange | fx:quotes:write, fx:operations:read, fx:operations:write, fx:payout-accounts:read, fx:payout-accounts:write |
- Rota fora dos escopos da credencial responde
403 AUTH.ENTITLEMENT_MISSING. - Consultas de pagamento aceitam qualquer
payments:<método>:reade mostram só os métodos liberados. Um pagamento de método sem leitura responde404 PAYMENT.NOT_FOUND. - No sandbox o produto é liberado na hora; em produção passa por aprovação da Kodano.