Jump to Content
Hiperbanco - Seu banco digital
HomeManualAPI
v1.0

Log InHiperbanco - Seu banco digital
Manual
Log In
v1.0HomeManualAPI
All
Pages
Start typing to search…

WEBHOOKS

  • Visão geral
  • Pré-requisitos para configuração
  • Estrutura Básica dos Webhooks
  • Configurações dos webhooks
    • Registro de um novo webhook
    • Consulta de todas as configurações de webhooks
    • Alteração de configuração
    • Exclusão de configuração
  • Mensagens
    • Consulta de mensagens enviadas
    • Reprocessamento de mensagens

EVENTOS WEBHOOK

  • Pix e DICT
  • Autorização e confirmação (Authorization)
  • Boleto
  • Cartão
  • Contas (Account)
  • Open Finance
  • Pessoa Física (Customer)
  • Pessoa jurídica (Business)
    • MEI, EI, EIRELI ou SLU
    • LTDA, S.A. e TS
  • Envio de imagens para Onboarding (Document)
  • Pagamento de Contas (Payments)
  • TED
  • SLC

Registro do cliente

  • Visão Geral
  • Pessoa física
    • Registro de pessoa física
    • Ciclo de vida do cliente
  • Pessoa Juridica
    • LTDA, S.A e TS
      • Envio de documentos LTDA, S.A. e TS
      • Registro de LTDA, S.A. e TS
    • MEI, EI, EIRELI ou SLU
      • Registro de MEI, EI, EIRELI ou SLU
  • Motivos de reprovação de registro

ID ONE

  • Visão geral
  • Envio e análise de documentos pessoais com ID One - Registro Pessoa Física
  • Envio e análise de documentos pessoais com ID One - Representante Legal (PJ)
  • Orientações para envio de fotos

Autenticação

  • Autenticação - Usuario

PIX

  • Diretório de chaves - DICT
    • Consulta de chaves de uma conta
    • Cadastro de chaves
    • Exclusão de chaves
  • Pagamentos
    • Consulta de chaves de uma conta para transação
    • Recebimento de valores via Pix
    • Transferência via Pix
    • Consulta do status da transação
  • QR Code
    • Emissão de QR Code estático
    • Emissão QR Code dinâmico
    • Decodificação de QR Codes
  • Reivindicação de chaves Pix
    • Criação de pedido de reivindicação
    • Consulta dos pedidos de reivindicação
    • Confirmação de um pedido de reivindicação
    • Completando o pedido de reivindicação
    • Cancelamento de um pedido de reivindicação

TED

  • Visão Geral
  • Recebimento de valores via TED
  • Transferência via TED
  • Consulta do status da transação
    • Consulta por código de autenticação

BOLETO

  • Visão geral
  • Processo de emissão de boleto
    • Emissão de boleto
    • Consulta por authenticationCode
    • Impressão de boleto
  • Cancelamento
  • Pagamento de boleto

Pagamento de Contas

  • Visão Geral
  • Processo de pagamento
    • Validação do título
    • Confirmação do pagamento
  • Consulta do status da transação
    • Consulta por código de autenticação

Open Finance

  • Visão Geral
  • Transmissão de dados por WebView
  • Geração do ticket de acesso ao WebView
  • Gestão de consentimentos
  • Processo de handoff

Gestão de Cartões

  • Visão geral
  • Definições
  • Emissão de Cartão
    • Criação de cartão Físico / Virtual
    • Emissão de segunda via
  • Consulta de cartões
    • Por proxy
    • Por documento (CPF ou CNPJ)
    • Por conta
    • Dados de segurança do cartão
  • Rastreio de Cartões
    • Por proxy
    • Alteração de endereço
  • Gestão do status
    • Alteração do status do cartão
    • Ativação do cartão
    • Consulta dos próximos status
    • Possíveis status do cartão
    • Configuração do contactless
  • Vinculação do cartão com uma conta bancária
  • Consulta de transações por cartão
  • Alterar senha do cartão

PLANOS

  • Informações do plano atual para o usuário

SLC

  • Visão geral

CÓDIGOS

  • Código de ocupação do cliente
  • Código da natureza jurídica (legalNature)
  • Faixa de renda declarada
  • Faixa de faturamento anual da empresa

Serviços Auxiliares

  • Listagem de Instituições

Gestão do Banco

  • Autenticação Gestão do Banco
  • Offboarding
    • Visão Geral
    • Encerramento de contas
  • Conta
    • Consultar todas as contas criadas
    • Detalhe da conta
    • Consultar limites da conta por feature
  • Tarifa Pontual
    • Visão Geral
    • Criação de tarifa pontual
    • Listar todas as tarifas pontuais emitidas
    • Detalhes da tarifa pontual
    • Cancelar uma tarifa pontual
  • Planos
    • Visão geral
    • Criação de planos
    • Listar todos os planos criados
    • Detalhes do plano
    • Atualizar um plano
    • Remover um plano
    • Alterar plano de um usuário
    • Contas vinculadas a um plano
    • Histórico de cobranças mensais do plano por conta
  • Cartões
    • Aprovação de Solicitação e Controle de Estado
    • Listagem de cartões
    • Cartões No Name
      • Emissão de cartões em lote
      • Vinculação do cartão com uma conta bancária

Homologação

  • Homologação

Limites Transacionais

  • Visão Geral
  • Consultar limites por feature
Powered by 

Configurações dos webhooks

Com a URI de seu endpoint em mãos, será possível:

  • Registrar um webhook;
  • Consultar todas as configurações dos webhooks;
  • Alterar uma configuração;
  • Excluir uma configuração;

Updated 11 days ago


Estrutura Básica dos Webhooks
Registro de um novo webhook