Visão Geral - Gestão do Banco

Esta seção da documentação foi desenvolvida para que o parceiro Hiperbanco tenha acesso a endpoints específicos voltados ao gerenciamento da solução financeira.

Por meio dela, o parceiro encontrará manuais e instruções para:

Autenticação Backoffice

⚠️
Importante
Para utilizar qualquer endpoint desta seção, o parceiro deve estar autenticado por meio do endpoint de Autenticação de Gestão do Banco.
Os demais endpoint, deverão utilizar Autenticação de usuário.

Webhooks

Os webhooks são recursos que permitem a comunicação em tempo real entre sistemas ou aplicações sempre que um evento ocorre, sem necessidade de ação manual no momento da transmissão.

Neste módulo, estão disponíveis ao parceiro Hiperbanco as seguintes ações:

Conhecer a estrutura básica dos webhooks: Entender o formato das mensagens enviadas, os tipos de eventos suportados e como os dados são transmitidos.
Registrar um novo webhook: Configurar um endpoint para receber notificações automáticas de eventos específicos.
Consultar configurações do webhook: Visualizar os parâmetros atuais de um webhook, como URL de destino, eventos associados e status.
Alterar configuração do webhook Atualizar dados de configuração, ajustando endpoints ou eventos monitorados conforme necessidade.
Excluir um webhook: Remover um webhook registrado, interrompendo o envio de notificações para aquele endpoint.

Gestão de Contas, Onboarding e Offboarding

Nesta seção, o parceiro Hiperbanco terá acesso a endpoints que permitem o gerenciamento completo do ciclo de vida das contas dos usuários.

Neste módulo, estão disponíveis ao parceiro Hiperbanco as seguintes ações:

Consultar contas criadas: Permite listar todas as contas já registradas no sistema, oferecendo uma visão geral do portfólio de clientes ativos.
Consultar detalhes das contas: Disponibiliza informações específicas de uma conta, como dados cadastrais e status da conta.
Bloqueio temporário da conta do usuário: Possibilita suspender temporariamente o acesso de um usuário à sua conta, garantindo maior segurança em casos de suspeita de fraude ou necessidade de revisão.
Consultar tentativas de registro (onboarding): Exibe registros de tentativas de criação de contas, incluindo casos bem-sucedidos e falhas, auxiliando na análise de processos de entrada.
Consultar detalhes do onboarding: Fornece informações detalhadas sobre o processo de registro de um usuário, como os dados utilizados, pendências e validações necessárias.
Realizar o processo de offboarding do usuário : Permite encerrar a relação de um usuário com o sistema, desativando sua conta e garantindo conformidade com requisitos regulatórios e de segurança.

Tarifa Pontual

A Tarifa Pontual permite ao parceiro Hiperbanco realizar débitos na conta do cliente mediante autorização prévia formal, de forma imediata ou programada, conforme previsto em contrato ou termo de adesão.

Neste módulo, estão disponíveis ao parceiro Hiperbanco as seguintes ações:

Criar tarifa pontual: Permite registrar uma nova cobrança autorizada pelo cliente, seja imediata ou programada.
Listar todas as tarifas pontuais emitidas: Exibe o histórico de tarifas já criadas, facilitando o acompanhamento e controle das cobranças.
Exibir detalhes da tarifa pontual: Mostra informações específicas de uma tarifa.
Cancelar uma tarifa pontual: Possibilita encerrar uma cobrança antes da efetivação.

Gestão de Planos

O módulo de Gestão de Planos permite ao parceiro Hiperbanco administrar mensalidades e tarifas transacionais aplicadas às contas de seus clientes.

Neste módulo, estão disponíveis ao parceiro Hiperbanco as seguintes ações:

Criar planos: Registrar novos modelos de cobrança com regras específicas de tarifas e mensalidades.
Listar todos os planos criados: Exibir a relação completa dos planos disponíveis no sistema.
Detalhes dos planos: Consultar informações específicas de cada plano, como valores, regras e condições aplicadas.
Atualizar planos: Alterar parâmetros de um plano existente, garantindo flexibilidade na gestão.
Remover um plano: Excluir planos que não possuam contas ativas vinculadas.
Alterar o plano de um usuário: Migrar um cliente de um plano para outro, conforme necessidade ou perfil.
Verificar as contas vinculadas a um plano: Listar todas as contas associadas a determinado plano, facilitando o controle.
Histórico de cobranças mensais de um plano: Consultar registros de mensalidades cobradas, permitindo auditoria e acompanhamento financeiro.

Gestão de Cartão

O módulo de Gestão de Cartão permite ao parceiro Hiperbanco visualizar os cartões virtuais dos clientes e administrar solicitações de cartões físicos.

Neste módulo, estão disponíveis ao parceiro Hiperbanco as seguintes ações:

Aprovar solicitações de cartão físico: Autorizar a emissão de cartões físicos solicitados pelos clientes.
Gerenciar status dos cartões: Atualizar o status de cartões (ativo, bloqueado, cancelado etc.).
Listar todos os cartões: Exibir a relação completa de cartões vinculados às contas dos clientes.
Emitir cartão no-name: Gerar cartões No-Name.
Vincular cartões no-name a uma conta: Associar um cartão No-Name diretamente a uma conta de cliente, permitindo seu uso conforme regras definidas.

Transações

O módulo de transações permite ao parceiro Hiperbanco, visualizar todas as transações efetuadas no banco.

Neste módulo, estão disponiveis ao Parceiro Hiperbanco a seguinte ação:

Listar todas as transações: Exibe todas as transações efetuadas dentro do sistema.

Updated 29 days ago