Manual de Integração Conta Vinculada IaaS

Confira como se integrar a conta vinculada do IaaS.

Bem-vindo ao Banking as a Service do Itaú!

Este documento é um guia para a integração com a Conta Vinculada IaaS. Ao completar as configurações necessárias, sua empresa terá acesso ao universo da conta garantia por meio dos nossos serviços. Este material foi construído com o intuito de auxiliar o seu time de desenvolvimento durante a integração com as APIs do produto, evitando erros durante o processo.

Além do manual, no decorrer da integração, é possível contar com o suporte de nossa equipe especializada, que está disponível para esclarecer as suas dúvidas. Para isso, entre em contato com o time de integração ou de atendimento ao cliente parceiro.

Pré-requisitos

Para iniciar a sua jornada de integração com a Conta Vinculada IaaS você precisa:

Atenção: O time IaaS participará do processo de homologação com o intuito de garantir que tudo funcione corretamente e, posteriormente, prestaremos apoio também no ambiente produtivo.

Boas Práticas para o desenvolvimento com a Conta Vinculada IaaS

Antes de começar, é importante se atentar às boas práticas para o melhor desenvolvimento da sua jornada com a Conta Vinculada IaaS.

Eventos de Webhook:

  • Estudo dos Eventos: Dedique tempo para entender os diferentes tipos de eventos de webhook que podem ser recebidos. Isso inclui o formato dos dados e como eles devem ser processados;
  • Base de Dados: Planeje a estrutura da base de dados para armazenar as informações recebidas dos webhooks. Isso pode incluir tabelas específicas para diferentes tipos de eventos.

Observação: Além de todos os eventos de webhook descritos nas documentações do Full IaaS, há também eventos de webhook específicos para a liquidação de valores de contas vinculadas.

Desenvolvimento Paralelo:

  • Por Domínio: Se optar por paralelizar o desenvolvimento, organize as equipes por capacidade: onboarding, liquidação e encerramento de conta.
  • Comunicação: Mantenha uma comunicação clara entre as equipes para garantir que todos os domínios estejam alinhados e que não haja duplicação de esforços.

Estimativas de Desenvolvimento:

  • Tempo Estimado: Em média, o tempo estimado para desenvolver as capacidades da Conta Vinculada é de 60 dias;
  • Desenvolvimento e Testes Unitários: As estimativas de tempo incluem apenas o desenvolvimento e a realização de testes unitários. Isso garante que o código esteja funcional e livre de erros básicos;
  • Homologação Funcional: Após o desenvolvimento de cada capacidade, realize uma homologação funcional. Isso deve ser feito em conjunto com o account manager responsável para garantir que todos os requisitos foram atendidos e que o sistema está pronto para o ambiente de produção.

1. Integração Full IaaS

Como descrito nos pré-requisitos, para utilizar a Conta Vinculada IaaS é necessário contratar também o Full IaaS. Portanto, a primeira etapa é seguir as instruções do Manual de Integração Full IaaS.

2. Opt-in

Durante o processo de onboarding para a criação de uma conta vinculada, é essencial que o cliente parceiro ofereça uma opção para que o cliente Pessoa Jurídica (PJ) possa dar seu consentimento (opt-in) aos termos de uso do contrato do produto, registrando formalmente seu consentimento.

Para viabilizar essa ação, é necessário implementar o endpoint POST /Realizar Consentimento para um termo de uso específico da API IaaS - Know Your Customer (PF e PJ).

3. Onboarding

Com as etapas anteriores concluídas, implemente o endpoint POST/Criar Conta Vinculada da API IaaS - Onboarding - PF e PJ. Com essa API, é possível realizar a criação de contas vinculadas.

Testes sugeridos para a implementação da API:

Confira abaixo os testes sugeridos para se integrar com os endpoints de opt-in, onboarding e encerramento da Conta Vinculada IaaS:

Download da tabela de testes de opt-in, onboarding e encerramento.

Observação: Nesta etapa, também estão incluídos alguns cenários de teste relacionados ao opt-in, além de um cenário específico para o encerramento de contas vinculadas. Isso se deve ao fato de que a implementação da API de encerramento de contas já terá sido concluída durante a integração com o Full IaaS, conforme detalhado a seguir.

4. Liquidação

Após o onboarding, é necessário se integrar à API de liquidação de conta vinculada. Assim, implemente a API IaaS - Liquidação Conta Vinculada. A partir da integração com essa API, o cliente parceiro consegue movimentar a conta vinculada enviando instruções de liquidação para sua própria conta livre-movimento ou para a conta livre-movimento de seu cliente PJ.

Testes sugeridos para a implementação da API:

Confira abaixo os testes sugeridos para se integrar com a API de liquidação da Conta Vinculada IaaS:

Download da tabela de testes de liquidação.

5. Consulta de saldo

Existem duas possibilidades para consultar o saldo de contas vinculadas, sendo eles:

  1. O cliente parceiro do IaaS consulta o saldo da conta vinculada de seu cliente PJ (GET/ Consultar saldo com token franquia);
  2. O próprio cliente PJ consulta o saldo da sua conta vinculada (GET/ Consultar saldo com token cliente).

Com a implementação dos endpoints GET/ Consultar saldo com token cliente e GET/ Consultar saldo com token franquia da API IaaS - Saldo - PF e PJ durante a integração com o Full IaaS, também é possível realizar consultas de saldo das contas vinculadas. Não há diferença nos endpoints para consulta de saldo de contas vinculadas ou outros tipos de contas IaaS.

6. Consulta de extrato

Com a implementação do endpoint GET/Consultar lançamentos efetivados da API IaaS - Extrato - PF e PJ durante a integração com o Full IaaS, também é possível que o cliente PJ consulte o extrato de sua conta vinculada. Não há diferença no endpoint para consulta de extrato de contas vinculadas ou outros tipos de contas IaaS.

Observação: Enquanto na API de saldo há endpoints tanto para o cliente parceiro quanto para o seu cliente PJ consultar o saldo de contas vinculadas, na API de extrato apenas o cliente PJ pode consultar.

Testes sugeridos para a implementação da API:

Confira abaixo os testes sugeridos para se integrar com as APIs de consulta de saldo e consulta de extrato da Conta Vinculada IaaS:

Download da tabela de testes de consulta.

7. Encerramento de conta

Com a implementação do endpoint DEL/Encerrar conta da API IaaS - Contas - PF e PJ durante a integração com o Full IaaS também é possível encerrar contas vinculadas. Não há diferença no endpoint para encerrar contas vinculadas ou outros tipos de contas IaaS.

Observação: Caso o cliente PJ, titular da conta livre-movimento, tenha uma conta vinculada ativa, não será possível encerrar a conta corrente. Para encerrar a conta corrente é preciso encerrar primeiro a conta vinculada.