Configurações

O menu Configurações, disponível em CADASTROS E CONTA, concentra as opções de administração da conta relacionadas às integrações de API, aos usuários com acesso à conta e à consulta dos limites vigentes.

O menu é dividido em quatro abas:

• API QRCODES
• API CONTAS
• PERMISSÕES
• MEUS LIMITES

Importante: este guia explica como administrar essas configurações no sistema. O uso dos endpoints, os detalhes de conexão e a integração técnica das APIs devem ser consultados na documentação específica das APIs.

API QRCODES

A aba API QRCODES permite administrar as credenciais e os webhooks utilizados pela integração da API de QR Codes.

Acessar a documentação da API

Clique em Documentação para consultar a documentação técnica da API.

A documentação de endpoints e integração não faz parte do escopo deste guia.

Criar uma nova credencial

Use Nova credencial para gerar uma credencial de acesso à API.

Preencha os campos solicitados:

1. Descrição — informe uma identificação para a credencial.
2. Permissões da credencial — selecione os escopos que a credencial poderá utilizar. O botão Ativar todas permite selecionar todos os escopos de uma vez.
3. IPs permitidos — informe os IPs autorizados a utilizar a credencial.

Depois de preencher os campos, clique em Gerar.

Atenção: a credencial, os IPs e o certificado mTLS são gerados nesse mesmo processo. O PFX e a senha retornada devem ser armazenados com segurança, pois não serão exibidos novamente.

Administrar as credenciais

Depois de criada, a credencial aparece na lista Credenciais API.

A lista apresenta:

• Descrição
• Credencial
• Status — Ativa ou Inativa
• IPs permitidos
• Ações

Nas ações da credencial, estão disponíveis:

• Copiar Client ID — copia o identificador da credencial.
• Ver credencial — exibe os dados da credencial.
• Revogar credencial — desativa a credencial.

Configurar webhooks

A seção Webhooks permite cadastrar a URL que receberá os avisos automáticos enviados pela API.

Clique em Configurar e preencha:

• TIPO
  • Cobrança — acompanha uma chave Pix específica da conta. A cobrança imediata gera a notificação para essa chave.
  • Pix — aplica-se à conta toda, sem vinculação a uma chave Pix.
• CHAVE PIX — informe a chave da conta que será acompanhada quando o tipo selecionado for Cobrança.
• URL — informe o endereço do sistema que receberá os avisos.
• Clique em Salvar para concluir.

O histórico dos disparos fica disponível no próprio menu e é retido por até 15 dias.

API CONTAS

A aba API CONTAS possui a mesma estrutura básica para administração das credenciais da API de Contas.

Criar e administrar credenciais

Em API CONTAS, estão disponíveis:

• Documentação
• Nova credencial
• Credenciais API

Ao criar uma credencial, o sistema apresenta o mesmo fluxo de administração descrito na aba API QRCODES.

Na lista de credenciais, estão disponíveis as ações:

• Copiar Client ID
• Ver credencial
• Revogar credencial

Configurar webhooks por tipo de evento

Na seção de webhooks da API CONTAS, cada tipo de evento é apresentado separadamente.

Os tipos disponíveis são:

• Transferência
• Recebimento
• Estorno
• Fila de Saída de Pagamentos
• Infrações
• Cripto

Para cada tipo, a tela apresenta o Status e a URL cadastrada.

Quando ainda não existe uma URL configurada, o evento aparece como Não Configurado, com status Pausado e URL NÃO CONFIGURADO.

Reenviar webhooks de um período

O recurso Reenviar webhooks do período permite colocar novamente na fila os disparos de um intervalo específico.

Como funciona: todos os webhooks ativos da conta entram na fila. Webhooks pausados são ignorados. Mesmo os disparos que já foram entregues são reenfileirados.

Para realizar o reenvio:

1. Informe o INÍCIO DO PERÍODO e o FIM DO PERÍODO.
2. Respeite o limite máximo de 2 dias de intervalo por reenvio.
3. Consulte a prévia apresentada pelo sistema. Ela informa a quantidade de webhooks no período, separando os registros em entregues, falhos, aguardando e enviando.
4. Confira os valores apresentados e, se necessário, ajuste o período.
5. Clique em Reenviar webhooks do período para colocar os disparos novamente na fila.

O histórico disponível para esse recurso é retido por até 15 dias.

Consultar o histórico de webhooks

A tela Histórico de webhooks permite acompanhar os disparos realizados para as URLs configuradas.

No topo, o sistema apresenta os contadores de:

• Webhooks ativos
• Webhooks pausados
• Aguardando disparo
• Enviando
• Entregue
• Falhou

A tela também disponibiliza:

• Busca
• Filtro Avançado
• Filtro de período: Hoje, 7d, 30d ou Selecionar período

Os dados são retidos por até 15 dias, e a contagem exibida no topo considera as últimas 24 horas.

Quando não houver registros no intervalo selecionado, o sistema exibirá:

Nenhum item encontrado para a data selecionada

Observação: a API de QR Codes também possui uma tela própria de Histórico de webhooks, com a opção Reenviar webhooks, destinada aos disparos daquela chave. O funcionamento do reenvio segue as mesmas regras apresentadas neste guia.

Permissões

A aba PERMISSÕES permite administrar os usuários que possuem acesso à conta.

Cada usuário é apresentado com:

• Nome
• CPF
• Cargo — por exemplo, Titular, Signatário e TI
• Status
• Data de criação
• Data de expiração
• Ações

Conceder acesso a um usuário

Para adicionar um usuário à conta, clique em Nova Permissão.

1. Informe o CPF DO USUÁRIO.
2. Clique em Conceder permissão.

Importante: caso o CPF ainda não possua cadastro, o cadastro pode ser realizado pelo App, utilizando a opção Cadastro sem conta.

Administrar o acesso de um usuário

Na coluna Ações, é possível administrar o acesso de cada usuário:

• Permissões — ajusta o que o usuário pode fazer.
• Bloquear — suspende o acesso do usuário.
• Remover — remove o usuário da conta.

Localizar um usuário

Use o botão Avançado para abrir os filtros da lista.

Os filtros permitem definir campo, operador e valor para localizar o usuário desejado.

Meus Limites

A aba MEUS LIMITES é destinada exclusivamente à consulta dos limites vigentes da conta.

Os limites não podem ser alterados nessa tela.

O sistema apresenta a janela horária da conta. No exemplo apresentado, o Período noturno é de 20:00 a 06:00.

A tela também exibe a política vigente e seus respectivos limites. No exemplo deste guia, a política é Envio de Pix, com as dimensões:

• Diurno
• Noturno
• Diurno para favorecidos
• Noturno para favorecidos

Para cada dimensão, são apresentados o Limite vigente e, quando existir, uma Alteração pendente.