Pré requisitos

Integrar com APIs pode parecer complexo, mas com a documentação correta o processo se torna claro e eficiente.

Veja abaixo os passos necessários para que o parceiro realize a integração com as APIs do Hiperbanco.

1. Obtenha suas credenciais

Após a formalização do contrato e a realização do kickoff com a equipe de Clientes, o parceiro do Hiperbanco receberá suas credenciais de Sandbox, que possibilitam o acesso às APIs e o início da jornada de integração em ambiente de sandbox.

Posteriormente, uma vez concluída a análise de Compliance pelo Banco Liquidante e após a homologação da aplicação pelo time de Integrações do Hiperbanco, serão disponibilizadas as credenciais de produção.

Essas credenciais funcionam como uma chave de acesso exclusiva, habilitando o parceiro a iniciar oficialmente suas operações em ambiente produtivo.

⚠️
Importante
É obrigatório que o parceiro informe a URL da aplicação, a qual será utilizada para a solicitação das credenciais necessárias ao processo de integração com o idOne.

2. Faça o download de um programa que permita realizar requisições às APIs

Para testar as APIs desejadas, o parceiro precisa instalar uma ferramenta de requisições, como Postman, Insomnia ou outra plataforma similar. Com esses programas, é possível realizar chamadas aos endpoints desejados.

3. Autenticação

Dentre às API do Hiperbanco, existem dois tipos de autenticação que o parceiro deverá realizar

Autenticação Backoffice

Com essa autenticação, o parceiro terá acesso aos endpoints que permitem configurar e gerenciar o projeto, incluindo o cadastro de webhooks, a consulta de contas criadas e outras operações relacionadas à administração.

📘
Nota
Para mais explicações sobre essa autenticação, visite a página de Autenticação - Gestão.

Autenticação do usuário

Com essa autenticação, o parceiro poderá acessar os endpoints que permitem realizar transações, emitir boletos e executar outras operações ligadas ao usuário que já possui uma conta criada.

4. Realize a integração com o produto desejado

Após concluir a autenticação, o parceiro poderá acessar a seção do manual referente ao produto que deseja integrar. Em cada seção estarão disponíveis todas as informações necessárias para utilizar os endpoints correspondentes.

5. Endpoints de Cash-out (Pix, TED e Pagamento de Contas)

Para realizar operações de cash-out (Pix, TED, P2P ou pagamento de contas), o parceiro deve primeiro receber as credenciais de sandbox e abrir uma conta, seja de pessoa física (PF) ou jurídica (PJ). Depois da abertura, é necessário informar o número do documento (CPF ou CNPJ) e o número da conta via Google Chats, para que o saldo seja creditado e as transações possam ser realizadas.

👍
Dica
O parceiro deverá solicitar adição de saldo para somente uma conta e a partir dela, realizar os testes necessários