Permissões
É fundamental detalhar as permissões, pois elas definem o modelo de governança de uma Conta Escrow. Na sua API, as permissões são atribuídas a cada Pessoa (Party) vinculada à Conta e definem o que aquela pessoa pode fazer.
As permissões são enviadas no array permissions dentro da estrutura parties durante a criação da conta (POST /v1/accounts).
📝 Detalhamento das Permissões (Permissions)
As permissões controlam o acesso a diferentes recursos da conta, desde a visualização de extrato até a criação e aprovação de movimentações financeiras.
Permissões de Gestão da Conta e Usuários
| Permissão | Descrição |
|---|---|
| VIEW_ACCOUNT | Permite visualizar os detalhes e configurações da conta. |
| MANAGE_USER | Permite gerenciar (adicionar/remover/editar) outros usuários ou partes relacionadas à conta (embora a alteração de parties não seja suportada via API, essa permissão é para gestão de usuários). |
| CREATE_ACCOUNT | Permissão para criar novas contas (relevante para entidades Administradoras ou Gestoras). |
Permissões de Movimentação (Postings)
Este conjunto de permissões controla o fluxo de transferência de fundos (Pix/TED/Pagamento de Boleto).
| Permissão | Descrição | Regra de Negócio |
|---|---|---|
| POSTING_CREATE | Permite iniciar/criar uma nova movimentação (POST /v1/postings). | Uma pessoa com apenas esta permissão cria uma transação que ficará no status "Aguardando Aprovação". |
| POSTING_REVIEW | Permite revisar e aprovar uma movimentação pendente (PUT /v1/postings/:postingId/review). | Se a pessoa tiver ambas (CREATE e REVIEW), pode usar automaticallyApprove=true para executar a transação imediatamente. |
| POSTING_VIEW | Permite consultar o status e detalhes de movimentações (Postings). |
Permissões de Cobrança (Wallets / Charges)
Estas permissões controlam a capacidade de configurar regras de cobrança e emitir títulos (boletos/Pix Cobrança).
| Permissão | Descrição |
|---|---|
| CREATE_WALLET | Permite criar novas Carteiras de Cobrança. |
| VIEW_WALLET | Permite consultar as Carteiras existentes. |
| UPDATE_WALLET | Permite alterar as configurações de uma Carteira. |
| ARCHIVE_WALLET | Permite arquivar/inativar uma Carteira. |
| CREATE_CHARGE | Permite criar (emitir) um novo boleto ou Pix Cobrança (Charge). |
| VIEW_CHARGE | Permite consultar o status e detalhes de Cobranças emitidas. |
| CANCEL_CHARGE | Permite cancelar uma Cobrança emitida. |
| UPDATE_CHARGE | Permite alterar informações de uma Cobrança. |
Permissões de Retenção e Garantia
Estas permissões controlam o acesso à funcionalidade de Retenção de Depósitos (Deposit Retention).
| Permissão | Descrição |
|---|---|
| CREATE_DEPOSIT_RETENTION | Permite criar uma nova regra de Retenção de Depósitos (Escrow de Fluxo). |
| VIEW_DEPOSIT_RETENTION | Permite consultar regras de Retenção de Depósitos. |
| UPDATE_DEPOSIT_RETENTION | Permite alterar regras de Retenção de Depósitos. |
| DELETE_DEPOSIT_RETENTION | Permite excluir/encerrar uma regra de Retenção de Depósitos. |
IMPORTANTE: O não-cumprimento das permissões é um problema comum. Se um cliente não consegue listar contas ou realizar uma operação, é provável que a credencial que ele está usando não esteja ligada a uma Pessoa que seja parte relacionada à conta e/ou não tenha a permissão necessária (ex: VIEW_ACCOUNT ou POSTING_REVIEW).
Updated about 21 hours ago