For AI agents: visit https://docs.hiperbanco.com.br/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Home Manual API

v1.0

Manual

v1.0Home Manual API

PRIMEIROS PASSOS

Visão Geral
Pré requisitos
Ambiente de Sandbox X Produção
Convenções
- Erros

Homologação

Requisitos para homologação

Gestão do Banco

Visão Geral - Gestão do Banco
Autenticação Gestão do Banco
Reset da senha do backoffice
Gestão de Contas e Onboarding
Tarifa Pontual
Planos
Cartões
Transações
- Listagem de todas as transações

WEBHOOKS

Visão geral
Pré-requisitos para configuração
Geração de assinatura HMAC
Estrutura Básica dos Webhooks
Configurações dos webhooks
Mensagens
- Consulta de mensagens enviadas
- Reprocessamento de mensagens
Lista de eventName disponiveis para cadastro
Lista de context disponiveis para cadastro

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
Orientações para envio de fotos
Criação Processo Selfie - PF
Criação Processo Selfie - Representante legal
Envio e análise de documentos pessoais com ID One
Envio e análise de documentos pessoais com ID One - Representante Legal

Autenticação

Autenticação - Usuario

PIX

Diretório de chaves - DICT
Pagamentos
QR Code
Reivindicação de chaves Pix
TOTP
- Geração do código numérico TOTP

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
Cancelamento
Pagamento de boleto
Upload de logomarca do 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
Rastreio de Cartões
- Por proxy
- Alteração de endereço
Gestão do status
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

Limites Transacionais

Visão Geral
Consultar limites por feature

Gestão da conta

Informações da conta + Saldo
Informe de Rendimento
Redefinição de senha
- Envia um SMS para obtenção do token
- Atualização da senha
Criar Conta Adicional

Powered by

Visão geral

Nesta seção será possível:

Listar todas as tentativas de cadastro dentro do banco.
Exibir os detalhes dos cadastros.

Updated 8 months ago

Desbloqueio de uma conta

Consultar todas as tentativas de onboarding criadas

Did this page help you?