Uma forma de recebimento por API (interface de programação de aplicações) refere-se a um método de processamento de pagamentos que utiliza uma interface de software para permitir a comunicação entre diferentes sistemas. No contexto de um banco, como o Banco Itaú, uma API de recebimento permite que sistemas, como o da Activesoft, integrem-se diretamente ao sistema bancário para registrar títulos, seguindo os protocolos de segurança e as regulamentações bancárias.
A Activesoft agora possui o BoleCode Itaú. Mas o que é isso?
O BoleCode (boleto híbrido) é a solução mais completa em termos de instrumento de pagamento, ao combinar o formato padrão do boleto bancário (código de barras) com o QR Code para pagamento via PIX.
Para conhecer mais sobre essa opção, acesse o material de apoio do Banco Itaú. Para pedir uma nova homologação bancária, entre em contato com o seu gerente de conta pelo e-mail cs@activesoft.com.br. Se você atingiu a quantidade de formas de recebimento permitida pelo seu plano contratado com a Activesoft, você pode solicitar um orçamento para contratação. O objetivo deste artigo é centralizar as operações relacionadas à forma de recebimento por API do Banco Itaú e as melhorias implementadas para auxiliar o usuário na parametrização como acesso administrativo.
Pré-requisitos antes de criar a forma de recebimento:
→ O credenciamento é disponível apenas para pessoas jurídicas (CNPJ);
→ A empresa da escola precisa ser cadastrada no sistema;
→ Os dados da empresa devem ser iguais à Receita Federal;
→ Ter criado a conta financeira da empresa;
→ Ter criado o favorecido da empresa e da tarifa bancária;
→ Ter criado o serviço único para o teste da homologação;
→ Ter cadastros para realizar o pagamento do boleto teste (o responsável financeiro precisa de CPF válido para o registro do título);
Ao seguir este guia, você aprenderá a:
1. Como cadastrar a forma de recebimento por API Itaú?
2. Como solicitar o credenciamento por API?
3. Como autenticar as credenciais?
4. Como gerar o boleto de teste da cobrança por API Itaú?
5. Como solicitar o credenciamento BoleCode para os títulos?
Como cadastrar a forma de recebimento por API Itaú?
O tutorial a seguir foi criado para orientar sobre como Homologar uma nova forma de recebimento por API junto ao Banco Itaú. Os campos marcados com (*) são obrigatórios. Siga o guia passo a passo abaixo:
a) No menu superior do sistema, clique em [Financeiro > Configurações] e, em seguida, localize a coluna [Contas a Receber]. Clique na opção [formas de recebimento];
b) O sistema direcionará para a tela de [Formas de recebimento];
c) Para criar uma nova forma de recebimento, localize e clique no botão [+ Nova forma de recebimento];
d) O Activesoft habilitará a tela de [Nova forma de recebimento]. Preencha os campos abaixo
- No campo [Tipo], selecione a opção [Boleto integrado];
- Em seguida, selecione a opção [itauAPI] no campo [Agente de cobrança];
e) Clique no botão [Confirmar] para prosseguir;
f) Após completar a etapa inicial do cadastro, o sistema direcionará para a etapa da configuração geral;
g) No campo [Nome], digite a nomenclatura da forma de recebimento a ser criada (exemplo: Banco Itaú - AG 1234 e CC 56789-0);
h) Os campos [Tipo e Agente de cobrança] estarão inativos devido às informações preenchidas na etapa anterior;
i) No campo [Conta vinculada aos recebimentos], selecione a conta financeira que deve ser vinculada à forma de recebimento. Se ainda não a criou, siga o guia passo a passo para criá-la aqui!
j) Mantenha ativado o ícone para que a forma de recebimento fique disponível para credenciamento e uso futuro;
k) Clique no botão [Próximo] para continuar;
l) Ao concluir a configuração geral do cadastro, o sistema direcionará para a etapa da [configurações de cobrança];
m) No campo [Favorecido vinculado à taxa bancária], selecione o beneficiário que receberá todas as despesas financeiras decorrentes do registro de títulos e outras taxas (exemplo: Tarifa Banco Itaú);
n) No campo [Favorecido referente aos pagamentos], selecione o beneficiário que receberá os créditos após o pagamento do boleto bancário na conta-corrente da escola (exemplo: Escola Mundo Verde LTDA);
o) Na seção [Dados para emissão de boletos bancários e cobrança registrada], preencha cuidadosamente os campos [agência], [Conta-corrente] e [Dígito verificador da conta] do Banco Itaú, pois será o domicílio onde os valores serão creditados;
p) No campo [Nome do cedente (Razão social e CNPJ)], insira o nome e CNPJ da empresa da escola como devem aparecer no boleto. Você também pode clicar no botão [Sugerir] para preenchimento automático pelo sistema;
q) Nos campos [Local de pagamento (informado no boleto)] e [texto de instrução adicional no boleto bancário], é possível inserir mensagens padrão para exibição no boleto e instruções aos responsáveis sobre os locais de pagamento;
r) Ative o ícone utilizar nosso número migração exclusivamente para escolas em processo de onboarding que precisam registrar no Activesoft (quando havia essa forma de recebimento em outro sistema). Ao ativar, preencha também os campos adicionais [posição inicial] e [tamanho];
s) Clique no botão [salvar] para continuar;
t) Ao concluir o cadastro de todas as etapas para criar uma nova forma de recebimento por API junto ao Banco Itaú, o sistema habilitará a tela baixar Certificado público;
u) Leia as orientações destacadas no quadrado azul. Aqui está a mensagem para sua conveniência
“Informações importantes!
Baixe o certificado público e o encaminhe para o Banco Itaú, para que a instituição forneça as credenciais de autenticação. Para validar a forma de recebimento, os dados fornecidos devem ser autenticados nas operações da listagem ou nos detalhes da forma de recebimento do tipo "Boleto integrado Itaú API". O certificado público pode ser baixado novamente nas operações da forma de recebimento.”
v) Clique no botão [Baixar certificado público] e, em seguida, no botão [fechar].
Como solicitar o credenciamento por API?
Após concluir o cadastro da nova forma de recebimento por API, é necessário enviar o certificado público gerado ao final da operação para o banco por e-mail. O gerente deve solicitar a abertura do credenciamento da API de cobranças do Banco Itaú por meio de um protocolo interno do banco, para a escola começar a gerar os boletos vinculados ao banco.
Como autenticar as credenciais?
Quando o protocolo for aberto pelo gerente, o cliente receberá um e-mail automático do Banco Itaú com as chaves (Cliente_ID e Token) anexas para serem inseridas no cadastro da forma de recebimento por API no sistema Activesoft.
O tutorial a seguir foi criado para orientar sobre como cadastrar as chaves na forma de recebimento. Os campos marcados com (*) são obrigatórios. Siga o guia passo a passo abaixo:
a) No Menu superior do sistema, clique em [Financeiro > Configurações] e, em seguida, localize a coluna [Contas a Receber]. Clique na opção [Formas de recebimento];
b) O sistema direcionará para a tela de [Formas de recebimento];
c) Localize a forma de recebimento por API junto ao Banco Itaú e clique no botão dos 3 pontinhos;
d) Clique na opção [Autenticar credenciais];
e) O Activesoft habilitará a tela de Autenticar credenciais XXXX. Preencha os campos abaixo (se os dados estiverem criptografados, ative o parâmetro credencias criptografadas);
- No campo Client ID, insira a chave enviada por e-mail;
- Em seguida, insira a outra chave no campo token;
f) Clique no botão [Salvar] para prosseguir;
Como gerar o boleto de teste da cobrança por API Itaú?
Para garantir que seus boletos sejam registrados com sucesso e que o crédito caia na conta da sua escola, é necessário realizar um teste após o credenciamento da forma de recebimento por API junto ao Banco Itaú.
Então, o que preciso fazer?
a) Criar um serviço exclusivo para a forma de recebimento
- O nome do serviço deve identificar o procedimento, incluindo o nome do banco e os dados de agência e conta. Exemplo: Homologação API Itaú - AG 1234 e CC 56789-0;
- Saiba mais aqui como criar o serviço;
b) Gerar o boleto de teste
- Após criar o serviço, gere um boleto de teste, alocando pelo menos um desconto para validá-lo;
- Cadastre um aluno e um responsável financeiro de testes, lembrando que o CPF e o CEP do responsável devem ser válidos, pois o Banco Itaú verifica esses dados automaticamente;
- Se já tiver os cadastros de teste prontos, siga para o próximo item. Se não, acesse os tutoriais para cadastrar o aluno [link] e do responsável financeiro [link];
- Com os cadastros feitos, siga o guia para gerar o boleto de teste no valor de R$ 20,00 para pagamento aqui;
- Com o boleto impresso, realize o pagamento do título por meio do seu app bancário, caixa eletrônico, agência ou nos correspondentes bancários autorizados;
c) Aguardar a compensação do pagamento
- Aguarde a compensação do pagamento, o arquivo de retorno será disponível conforme o prazo do banco, o tempo mínimo para a disponibilidade do arquivo é de 24h;
- Quando o arquivo estiver disponível lá no gerenciador bancário do banco, baixe e importe-o na área de importação de aquivo de retorno conforme o tutorial;
d) Inativar o serviço
- Após a compensação do pagamento, inative o serviço, por ser criado exclusivamente para validar e testar a nova forma de recebimento por API junto ao Banco Itaú;
Como solicitar o credenciamento BoleCode para os títulos?
Após concluir o credenciamento por API e inserir as chaves de autenticação, é possível habilitar o BoleCode para a forma de recebimento cadastrada, permitindo o pagamento por código de barras (formato padrão) ou Qr Code para PIX.
Para isso, será necessário solicitar novamente ao gerente da agência a abertura de um novo protocolo interno (credenciamento) para incluir a opção PIX nos títulos, indicando que já usa a API de cobranças Itaú e agora precisa usar o BoleCode também.
Quando o protocolo for aberto pelo gerente, o cliente receberá um novo e-mail automático do Banco Itaú com as chaves (Cliente_ID e Token) anexas para serem inseridas no cadastro da forma de recebimento por API.
O tutorial a seguir foi criado para orientar sobre como cadastrar as chaves para liberar a opção BoleCode nos títulos após ter recebido do Banco Itaú o e-mail com as chaves. Os campos marcados com (*) são obrigatórios. Siga o guia passo a passo abaixo:
a) No menu superior do sistema, clique em [Financeiro > Configurações] e, em seguida, localize a coluna [Contas a Receber]. Clique na opção [formas de recebimento];
b) O sistema direcionará para a tela de formas de recebimento;
c) Certifique-se que possui as chaves para cadastrar. Localize a forma de recebimento por API junto ao Banco Itaú e clique no botão dos 3 pontinhos;
d) Clique na opção [credenciar bolecode Itaú];
e) O Activesoft habilitará a tela de credenciamento bolecode Itaú. Leia as orientações destacadas no quadrado azul. Aqui está a mensagem para sua conveniência
“Dados obrigatórios necessários
O credenciamento só poderá ocorrer com o preenchimento de dados fornecidos pela instituição bancária. Para continuar, certifique-se de ter em mãos todos os dados a seguir:
- Identificador do cliente (Client ID)
- Token temporário
- Chave PIX de recebimento
Caso não possua algum dos dados, entre em contato com o seu banco"
f) Se já tiver todos os dados mencionados na lista acima, clique no botão [Continuar]. Se não, fale com o gerente da sua agência para obter as informações e concluir a liberação do bolecode na forma de recebimento no Activesoft;
g) O sistema direcionará para a tela credenciamento bolecode Itaú para inclusão das chaves
- No campo identificador do cliente (Client ID), insira a chave enviada por e-mail;
- Em seguida, insira a outra chave no campo [token temporário];
- Depois, selecione a chave da escola para recebimento dos valores no campo [tipo da chave PIX];
- Clique na opção [Salvar].
Prontinho ❤️! Agora você já sabe como configurar a forma de recebimento por API do Banco Itaú no Activesoft, inclusive com a ativação do BoleCode para pagamentos via PIX. Essa funcionalidade é ideal para garantir maior integração bancária, segurança nas transações e mais praticidade para os responsáveis no pagamento dos boletos.
Se este artigo foi útil para você, não esqueça de avaliá-lo aqui embaixo! Sua opinião é super importante para continuarmos melhorando nossos conteúdos 😉.
Comentários
0 comentário
Por favor, entre para comentar.