1. Visão Geral
2. Fluxograma completo de utilização
3. Como obter credenciais junto ao banco
   
   1. Pré-requisitos para realizar o procedimento completo de liberação de credenciais bancárias.
   2.  Acesso ao internet banking Inter.
   3. Criando uma nova API no Inter
   4. Preenchimento dos dados da API
   5. Seleção da conta corrente
   6. Seleção dos escopos de cobrança
   7. Download do certificado Inter
   8. Conversão do certificado Inter
4. Como configurar as credenciais no PlugBoleto
   
5. Recursos disponíveis API Inter
   
   1. Boleto Hibrido Inter 
      1. O que é necessário para utilizar o Boleto Hibrido com o banco Inter?
      2. Emitindo o boleto híbrido VIA API
      3. Consultando o boleto híbrido
      4. Impressão do boleto híbrido
   2. Consulta de Boletos
      1. Consulta individual
      2. Consulta geral em boletos REGISTRADOS
      3. Informações sobre Pagamento de Boletos disponível na API Sicoob
   3. Alteração de Boletos
      1. Requisitos para a Alteração de Boletos 
      2. Como ativar a Alteração via API
      3. Como disparar a requisição para realizar a alteração individual via API BANCÁRIA.
      4. Campos disponíveis para alteração 
   4. Baixa de Boletos
      1. Requisitos para a Baixa de Boletos
      2. Como solicitar a Baixa

Visão Geral

O recurso de transmissão instantânea foi desenvolvido para facilitar a integração de sistemas de cobrança com as APIs bancárias, oferecendo uma solução prática e eficiente para desenvolvedores.

Esse método permite a consulta direta dos dados dos boletos nos servidores bancários, retornando imediatamente após sua criação o status REGISTRADO como nos boletos de cobranças de grandes marketplaces.

Ao utilizar a transmissão instantânea, desenvolvedores conseguem implementar um fluxo de emissão de boletos mais ágil e seguro, permitindo que clientes finais possam realizar o pagamento dos títulos logo após a criação. Isso elimina o tempo de espera que existe no tradicional método de transmissão de remessas e obtenção de retorno que é D+1, já que cada boleto emitido pelo sistema é validado instantaneamente, integrando-se com o servidor bancário em tempo real.

Essa solução simplifica a comunicação com instituições financeiras, reduzindo o esforço de implementação e manutenção de sistemas de cobrança, enquanto melhora a experiência do usuário final. Com a transmissão instantânea, é possível construir aplicações financeiras robustas que garantem precisão nos dados de pagamento, ao mesmo tempo em que agilizam o processo de verificação e registro de boletos.

 

Atenção: Apesar de a captura do status de REGISTRO ou REJEIÇÃO via API ser imediato as LIQUIDAÇÕES(pagamentos) não seguem a mesma dinâmica, dependendo dos procedimentos internos do banco. Isso significa que o status de liquidação não está disponível instantaneamente e depende dos prazos internos de atualização de suas bases. Esse tempo pode variar de acordo com o banco e o serviço de API.

 

Fluxograma completo de utilização

Como obter credenciais junto ao banco

 

Pré requisitos para realizar o procedimento completo de liberação de credenciais bancárias

 

Basta ter uma conta corrente ativa no banco e acesso ao internet banking como titular da conta.

 

OBS: Para o Banco Inter via Web Service, o banco Inter realiza a integração apenas para pessoa Jurídica. 

 

1 Passo -  Acessar o internet banking

O primeiro passo para realizar a integração com o WebService, é acessar a sua conta do Banco Inter

 

2 Passo -  Criação da aplicação no banco

Depois de acessar a conta, no menu principal selecione a opção Conta Digital, e em sequência as opções Aplicações -> Nova aplicação.

 

3 Passo -  Preenchimento dos dados da aplicação

Neste passo  você vai precisar definir um nome e descrição para sua aplicação. Importante ressaltar que este campo é livre, e você pode preenche-lo da maneira que considerar melhor, visto que, seu preenchimento tem apenas a finalidade de manter um controle sobre as aplicações que comunicam com o Inter. Portanto, é necessário apenas preencher os campos e depois selecionar o botão "Próximo".

 

4 Passo -  Seleção da conta corrente que será utilizada

Neste passo basta identificar qual conta que será a beneficiaria das cobranças.

5 Passo -  Seleção dos escopos necessários

Selecione os serviços necessários para cobrança bancária, e logo após selecione o botão "Criar Aplicação".

 

Obs: a imagem de exemplo trata-se do serviço de pix, utilizem a apenas para se familiarizar com o layout da tela.

6 Passo -  Download do certificado Inter

Após a criação, você será direcionado à tela Gestão de Aplicações, onde sua aplicação será exibida com o Status "Novo". Expanda os detalhes e você poderá ver mais informações sobre a aplicação, por exemplo, as permissões e contas correntes vinculadas. Nessa tela, você pode clicar em "Baixar chave e certificado", eles serão utilizados para utilizar o PlugBoleto.

 

⚠️TEMPO DE VALIDADE DO CERTIFICADO

Os certificados gerados pelo Banco Inter tem prazo de duração de 1 ano. Depois desse prazo, uma nova aplicação deve ser gerada para configurar novamente as permissões desejadas e emitir um novo certificado.

 

Ao baixar as chaves e o certificado, as credenciais serão geradas e exibidas na mesma tela de detalhes, enquanto a aplicação passará por um processo de validação. Após alguns minutos, o status será atualizado para Ativo e a aplicação estará pronta para utilização.

 

7 Passo -  Conversão do certificado Inter

 

O certificado fornecido pelo banco Inter normalmente vem na extensão .crt com a .key, e a API de boletos aceita somente os formatos PFX, com isso é necessário realizar a conversão do certificado antes de poder realizar o upload dele. Assim, para realizar esse procedimento os passos estão descritos aqui.

Após realizar a conversão do certificado para o formato aceito em nossa API, basta fazer o upload do certificado, com extensão .PFX.

 

Como configurar as credenciais no PlugBoleto

 

Para melhor visualização e entendimento do processo vamos utilizar nossa GUI WEB para explicar o preenchimento de campos mas esse processo também poderá ser realizado via API conforme a documentação de integração com a API PlugBoletos.

Após realizar o cadastro da conta, acesse a na página de convênios e caso não tenha sido ainda criado o convenio referente a conta deve ser criado conforme a documentação de cadastro de convênios.

Com o convenio criado ative a opção "Registro instantâneo", esse campo é onde você habilita o uso desse recurso no seu convênio.

Quando o campo Registro instantâneo for ativado deve aparecer logo abaixo 4 novos campos que devem ser preenchidos da seguinte forma: 

• Versão Web service: Preencha com V3.
• API - ID: Preencha com o ClientID fornecido pelo banco
• Segredo: Preencha com o Client Secret fornecido pelo banco.
• Certificado: Faça o upload do arquivo .pfx do certificado obtido na conversão feita no 7 passo da Obtenção de credenciais.

Exemplo do cadastro das credenciais no portal do Plugboleto: 

 

Recursos disponíveis na Api Inter

 

Boleto Hibrido

O boleto híbrido do Inter combina as opções de pagamento via boleto e Pix para uma mesma cobrança. Isso permite oferecer aos clientes a flexibilidade de quitar o pagamento utilizando o código de barras do boleto ou o QR Code do Pix.

 

O que é necessário para utilizar o Boleto Hibrido com o banco Inter?

Para utilizar o boleto híbrido com o Banco inter, basta realizar a liberação das credenciais conforme descrito neste passo. Após isso, você estará apto a usar a API bancária. No caso do inter, não é necessária nenhuma liberação adicional de escopos ou serviços junto ao banco, com a credencial padrão já é possível realizar o registro.

 

Emitindo o boleto híbrido VIA API

Para comandar que um boleto seja  registrado no modelo HIBRIDO basta adicionar ao JSON de envio anteriormente implementado o campo chamado "hibrido": true, caso tenha duvidas sobre a implementação da rota de inclusão de boletos basta acessar nossa documentação.

Abaixo um exemplo do campo a ser adicionado:

{
  ...
  ...
  "TituloNossoNumero":"123",
  "TituloValor":"100,00",
  "hibrido": true
}

 

Consultando o boleto híbrido

A consulta do boleto hibrido segue a mesma implementação da consulta de boletos tradicionais conforme a documentação de consulta de boletos, sendo necessário apenas a leitura dos dois novos campos referentes ao boleto hibrido.

{
  "hibrido": true,
  "UrlPix": "http://plugboleto.com.br/api/v1/boletos/impressao/HRKCVJXVV/pix",
}

 

Impressão do boleto híbrido

Para saber mais sobre os tipos de impressão, acesse a documentação referente aos exemplos de impressão.

Exemplo de boleto híbrido:

Consulta de Boletos

 

Consulta individual

As  requisições que forem disparadas para o endpoint de consulta do Plugboleto serão imediatamente processadas e apresentará os dados atuais do titulo em nosso banco de dados, em seguida replicaremos a consulta diretamente no servidor bancário a fim de buscar uma possível atualização de dados, caso seja identificado uma atualização de status automaticamente será disparado um webhook de notificação para a Software House, caso não tenha webhook configurado é possível obter as atualizações realizando uma nova consulta em seguida.

Um boleto pode ter 7 situações diferentes, que podem ser verificadas neste link.

Para verificar quais campos são retornados nesta consulta, clique aqui.

Consulta Automática

 O PlugBoletos conta com rotinas de consultas automáticas que tem como intuito dar mais confiabilidade e celeridade as conciliações de boletos, no momento para o banco inter temos disponível apena a consulta geral, sem webhook ou francesa.

 

Consulta geral em boletos REGISTRADOS

Considerando que a consulta francesa e o webhook não estão disponíveis para o sicoob é realizada uma consulta em todos os títulos com status de REGISTRADO em nossa base, ela se inicia as  7 horas da manha e seu tempo de execução pode variar de acordo com o tamanho da base a ser consultada.

 

Informações do boleto atualizadas após a conciliação na API Inter.

Com a atualização via API o banco Inter reduz a quantidade de informações disponibilizadas sobre o pagamento limitando se as principais informações de LIQUIDAÇÃO:

• Situação
• PagamentoData
• PagamentoDataCredito
• PagamentoValorPago
• PagamentoValorAcrescimos

Vale apenas ressaltar que todas as outras informações da cobrança já foram capturadas e estamos focando apenas em campos atualizados após o pagamento do titulo.

 

Alteração Individual de Boletos via API

A alteração de boletos é útil em situações onde informações previamente registradas, como data de vencimento, valor ou valor de abatimento precisam ser modificadas após o titulo ja estar registrado. Abaixo está uma visão geral de como funciona o processo de alteração de boletos via API bancária no PlugBoletos.

 

Requisitos para a Alteração de Boletos

Antes de comandar uma alteração, é importante garantir que o boleto se enquadra em alguns requisitos. O boleto precisa estar REGISTRADO no Inter.

• Apenas determinados campos podem ser modificados, como data de vencimento, valor de cobrança, multa, juros e descontos aplicáveis.
• É necessário possuir as credenciais de autenticação bancárias descritas em Como obter credenciais junto ao Banco para acessar a Inter.

Como ativar a Alteração via API

 Para ativar a funcionalidade de alteração após ter configurado as credenciais no convenio basta ativar a opção "Alteração via WS" no cadastro de convenio.

 

Como disparar a requisição para realizar a alteração individual via API BANCÁRIA.

POST

Homologação:

Produção:

 

Headers

 

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-cedente	CNPJ do Cedente	01001001000113
cnpj-sh	CNPJ da Software House	01001001000113
token-sh	Token da Software House	f22b97c0c9a3d41ac0a3875aba69e5aa

 

 

Headers (Opcional)

 

Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-cedente	CNPJ do Cedente	01001001000113
token-cedente	Token do Cedente	f22b97c0c9a3d41ac0a3875aba69e5aa1

 

Campos disponíveis para alteração 

 

Campo	Descrição	Exemplo
TituloValor	Altera o valor do título    Boletos aptos a alteração de valor de acordo com as regras  especificas do Sicoob. Títulos cadastrados no sistema; Títulos abertos (não baixados e liquidados); Títulos não pagos (sem baixa operacional); Títulos vencidos; Títulos não vencidos; Títulos que não estejam em processo de protesto; Títulos não descontados; Títulos com Negativação agendada; Títulos com Negativação em andamento; Títulos negativados;	15,00
TituloDataVencimento	Alterar a data de vencimento	15/03/2023
TituloValorDescontoTaxa	Alterar o valor do desconto	100
TituloValorAbatimento	Alterar o valor do abatimento ou redução do valor do boleto	5
TituloCodProtesto	Alterar o código de protesto	8
TituloPrazoProtesto	Alterar a data do protesto	20/02/2023

 

Baixa de Boletos

Para boletos que alcançaram o status de REGISTRADO, o cancelamento só pode ser realizado através de uma solicitação formal de BAIXA. Esse processo, para o Sicoob, pode ser automatizado diretamente por meio da API bancária, facilitando o cancelamento e integração com sistemas de cobrança.

Requisitos para a Baixa de Boletos

1. Status de REGISTRADO: Assim que um boleto é registrado no banco, ele fica disponível para pagamento e segue sob controle do sistema bancário.
2. Solicitação de Baixa: Caso o boleto precise ser cancelado (por exemplo, devido a duplicidades, erros ou desistência de cobrança), uma requisição de baixa deve ser enviada ao banco.
3. É necessário possuir as credenciais de autenticação bancárias descritas em Como baixar títulos Webservice - Inter V2 para acessar a API Inter.

Como solicitar a Baixa

Para realizar a solicitação de baixa basta realizar a integração com o endpoint de baixa do Plugboletos.