Com um layout único e compatibilidade com dezenas de bancos, o Boleto TecnoSpeed permite que você registre remessas de boletos de cobrança de forma automática ou até mesmo instantânea, sem acessar o portal do banco.

Além do registro de boletos, a solução oferece recursos inteligentes para tornar o processo de recebimento do seu cliente muito mais eficiente, com ferramentas de conciliação, cobrança automática por e-mail e SMS, WebHooks e muito mais!

Neste artigo você terá todas as informações para conseguir realizar os cadastros e emitir um boleto seguindo os seguintes passos:

1. Como conseguir o Token
2. Acessando a GUI como SoftwareHouse
3. Acessando a GUI como Cedente
4. Preparando o Ambiente
5. Cadastrando um Cedente
   1. Via API
   2. Via GUI
   3. Via OCX
6. Cadastrando uma Conta
7. Cadastrando um Convênio
8. Entendendo o modo de registro Manual, Automático, WebService e o Misto
   1. Transmissão Manual
   2. Transmissão Automática
   3. Registro instantâneo via WebService bancário
   4. Registro Misto (WebService + VAN)
9. Fluxo ideal para a emissão de boletos
10. Rotas da API

---

 

Como conseguir o Token da Software House

 

O Token é utilizado em todas rotas/métodos da API PlugBoleto.

 

Ele é encontrado na Central do Cliente. Para acessar deve ser informado o e-mail cadastrado e a senha.

 

Após feito o Login siga os passos:

• Clique no botão MENU localizado no canto superior direito.
• Clique no botão API.
• A tela possui a opção de regerar o token. Caso a mesma seja executada, é extremamente importante que sua aplicação seja atualizada e recompilada com o novo valor. Caso isso não aconteça a sua aplicação ficará impedida de consumir os métodos da API.

 

Exemplo abaixo:

 

 

 

Acessando a GUI como Software House

 

Nossa GUI (Graphical User Interface) conta com dois perfis de acesso, o perfil de Software House e o perfil de Cedente.

Abaixo temos exemplos de como acessar com o perfil de Software House.

 

Ambientes de acesso

• Homologação - http://homologacao.plugboleto.com.br
• Produção - https://plugboleto.com.br

 

Após acessar a GUI independente do ambiente Homologação ou Produção, será solicitado o login, conforme imagem abaixo.

 

Para acessar como Software House deve ser informado o CNPJ e TOKEN da Software House.

Este token pode ser adquirido na central do cliente. Se tiver dúvidas sobre como logar no portal da central do cliente, clique aqui para acessar a nossa documentação.

 

Após realizado o login será apresentada a tela abaixo:

 

 

Acessando como Software House será possível realizar todos os pré requisitos básicos para a emissão de boletos.

 

Informações adicionais sobre o Token da Software House: 

Para realizar a alteração do token da sua Software House, é necessário ter acesso ao portal de clientes da empresa. Este portal é um ambiente restrito e seguro, destinado exclusivamente aos clientes da Tecnospeed e aos seus representantes autorizados.

É importante lembrar que somente aqueles que tiverem acesso ao portal de clientes da Tecnospeed poderão realizar a alteração do token de integração da sua Software House.

O token de integração é uma informação sensível e deve ser mantido em sigilo, pois ele é utilizado para garantir a segurança e a autenticidade das transações realizadas através das APIs da Tecnospeed.

 

 

Acessando a GUI como Cedente

 

Nossa GUI (Graphical User Interface) conta com dois perfis de acesso, o perfil de Cedente e o perfil de Software House.

Abaixo temos exemplos de como acessar com o perfil de Cedente.

 

Ambientes de acesso

• Homologação - http://homologacao.plugboleto.com.br
• Produção - https://plugboleto.com.br

 

Após acessar a GUI independente do ambiente Homologação ou Produção, será solicitado o login, conforme imagem abaixo.

 

Para acessar como Cedente deve ser informado o CNPJ ou CPF e TOKEN do Cedente. Este token pode ser adquirido em nossa GUI, para isso basta seguir os passos abaixo:

 

Adquirindo o token do Cedente

 

O primeiro passo seria acessar a nossa GUI como Software House, após realizar o login será apresendada a lista de cedententes, para visualizar o token do cedente, basta ir em ações e clicar em Editar cedente, como no exemplo abaixo.

 

 

Após clicar em Editar cedente, será apresentado os dados cadastrados anteriormente, e no final dá página, o campo token onde estará preenchido com o token específico daquele cedente.

 

 

Agora basta fazer logoff da sessão atual e acessar com o CNPJ/CPF e token do cedente adquirido nos passos anteriores. Após logar com os dados do cedente será apresentado a tela abaixo.

 

*Para visualizar o boleto, basta clicar 2 vezes no boleto que deseja a impressão

 

 

Preparando o Ambiente 

Para iniciar a integração em nosso sistema primeiramente se faz necessário localizar o CNPJ/CPF e o Token da Software House. Estes dados são utilizados para garantir a autenticidade da software house e portanto será utilizado em todas as rotinas de integração.

 

Para que você entenda e visualize melhor como localizar e utilizar estes dados, assista o vídeo abaixo:

 

 

---

Cadastrando um Cedente

Antes de fazer qualquer ação no produto, é necessário fazer o cadastro do cedente (Emissor da cobrança). Isso pode ser feito através da GuiWeb, via API ou via OCX.

O Cedente é cadastrado na base de dados da API e o cadastro deve acontecer individualmente, sendo assim, para cadastrar dois cedentes é necessário fazer a operação duas vezes.

O cadastro do cedente se resume em preenchermos um modelo de integração (TX2) com os dados do cedente e enviarmos para o nosso servidor

 

Cadastrando um Cedente via API

POST

 Homologação:

 Produção:

 

Headers

 

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

 

 

Body

 

Campo	Tipo	Descrição	Tamanho
CedenteRazaoSocial	string	Razão Social do Cedente	1 - 200
CedenteNomeFantasia	string	Nome Fantasia do Cedente	1 - 200
CedenteCPFCNPJ	string	CPF ou CNPJ do Cedente	11 (CPF) ou 14 (CNPJ)
CedenteEnderecoLogradouro	string	Endereço do Cedente	1 - 200
CedenteEnderecoNumero	string	Número do logradouro do endereço	1 - 10
CedenteEnderecoComplemento	string	Complemento do endereço	1 - 100
CedenteEnderecoBairro	string	Nome do bairro	1 - 100
CedenteEnderecoCEP	string	CEP do Cedente	8
CedenteEnderecoCidadeIBGE	string	Código IBGE da cidade do Cedente	7 (clique aqui para consultar o código de sua cidade)
CedenteTelefone	string	Número do telefone do Cedente	11
CedenteEmail	string	E-mail do Cedente	1 - 150

 

Exemplo:

Retorno

 

Exemplo de retorno:

 

 

Obs.: É importantíssimo persistir em seu banco de dados o ID do Cedente retornado na resposta da requisição. Ele será usado para fazer alterações no cadastro do cliente.

 

 

Exemplo de retorno com erro:

 

 

Cadastrando um Cedente via GUI

O cadastro através da GUI exige o login através do CNPJ e Token da software house e, caso utilize a API, é necessário informá-los no header da requisição.

Para fazer o cadastro através da GuiWeb, você deve primeiramente identificar o ambiente no qual o mesmo deve ser feito. Temos duas opções:

Homologação
Produção

Na tela de listagem de Cedentes , ao lado do título, encontra-se o botão para Adicionar novos cedentes:

 

Na tela seguinte, iremos preencher os dados para o cadastro de um cedente. Deve ser definido se o cedente a ser cadastrado é Pessoa Física ou Jurídica. Os campos obrigatórios são marcados por um asterisco "*".

Após o preenchimento de todos os campos obrigatórios já é possível encerrar o cadastro através do botão Salvar.

Com o cadastro encerrado/salvo existe a opção de editar informações do mesmo, com exceção do tipo de Pessoa (Física ou Jurídica) e o CPF ou CNPJ definidos durante o cadastro.

 

Após finalizar o cadastro do Cedente, cada um dos CNPJs cadastrados receberá também um Token, que dará acesso a um painel específico para os cedentes, onde seus clientes poderão, dentre outras coisas, acompanhar e visualizar todos os boletos que foram emitidos por eles.

E também, após o cadastro do cedente, você conseguirá identificar o ID deste cedente na URL da página, apresentada no final do endpoint do domínio de nossa API.

 

Cadastrando um Cedente via OCX

 

Método

 

O método FBoletoX.CadastrarCedente possui apenas um parâmetro no formato WideString, nele deve ser informado o TX2 com as informações do cedente.

 

 

Campos

 

Campo	Tipo	Descrição
CedenteRazaoSocial	string	Razão Social do Cedente
CedenteNomeFantasia	string	Nome Fantasia do Cedente
CedenteCPFCNPJ	string	CPF ou CNPJ do Cedente
CedenteEnderecoLogradouro	string	Endereço do Cedente
CedenteEnderecoNumero	string	Número do logradouro do endereço
CedenteEnderecoComplemento	string	Complemento do endereço
CedenteEnderecoBairro	string	Nome do bairro
CedenteEnderecoCEP	string	CEP do Cedente
CedenteEnderecoCidadeIBGE	string	Código IBGE da cidade do Cedente
CedenteTelefone	string	Número do telefone do Cedente
CedenteEmail	string	E-mail do Cedente

 

Abaixo segue um modelo de exemplo para ser informado como parâmetro no método CadastrarCedente.

 

Modelo de Exemplo:

 

 

Retorno

Exemplo de retorno:

 

Exemplo de retorno com erro:

 

 

Exemplos

 

Delphi

 

 

Clique aqui para baixar um exemplo completo.

Clique aqui para visualizar um exemplo completo.

 

C#

 

 

 

Clique aqui para baixar um exemplo completo.

Clique aqui para visualizar um exemplo completo.

 

Visual Basic 6

 

 

Clique aqui para baixar um exemplo completo.

Clique aqui para visualizar um exemplo completo.

 

Fox Pro

 

 

Clique aqui para baixar um exemplo completo.

Clique aqui para visualizar um exemplo completo.

---

Cadastrando uma Conta

Os dados da conta serão usados como parâmetro em vários momentos: Geração e impressão de um boleto, geração do arquivo de remessa, etc. Dessa forma, precisamos fazer o pré-cadastro dela para que não seja necessário informá-la a todo momento. Para o nosso tutorial, vamos utilizar o id do cedente cadastrado no passo anterior.

 

POST

 Homologação:

 Produção:

 

Headers

 

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

 

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

 

Body

 

Campo	Tipo	Descrição
ContaCodigoBanco	string	Código do banco (3 dígitos)
ContaAgencia	string	Número da agência (sem DV)
ContaAgenciaDV	string	Dígito verificador da agência
ContaNumero	string	Número da conta (sem DV)
ContaNumeroDV	string	Dígito verificador da conta
ContaTipo	string	Tipo da conta. Valores aceitos: "CORRENTE" ou "POUPANCA"
ContaCodigoBeneficiario	string	Código do beneficiário
ContaCodigoBancoCorrespondente	string	Código do banco correspondente, disponível para os bancos 756, 707 e 136 *não preencher caso não utilizado*
ContaCodigoEmpresa	string	Código da empresa. Campo obrigatório para Bradesco e Daycoval.
ContaValidacaoAtiva	boolean	Define se validacao estará ativa na conta do cedente.
ContaImpressaoAtualizada	boolean	Define se a impressão será atualizada após o vencimento
ContaImpressaoAtualizadaAlteracao	boolean	Define se a impressão será atualizada com os dados de remessas de alterações gerado, mesmo que as alterações ainda não tenham sido confirmadas pelo banco. (Campo só pode ser utilizando quando o campo ContaImpressaoAtualizada for true)
ContaImpressaoAtualizadaLiquidado	boolean	Define se a impressão será atualizada para boletos com a situação LIQUIDADO, realizando o cálculo mesmo após o pagamento. Caso seja desabilitado não haverá atualizações. (Campo só pode ser utilizando quando o campo ContaImpressaoAtualizada for true) Valor default: true

 

Dica: Para auxiliar no cadastro da conta, possuímos uma seção de dicas, onde você encontra um detalhamento sobre as informações que devem ser preenchidas para cada banco.

Segue o link desta documentação: https://atendimento.tecnospeed.com.br/hc/pt-br/sections/360002897054-Dicas-para-cadastro-de-contas-e-conv%C3%AAnios

 

Exemplo:

Retorno

 

Exemplo de retorno:

 

 

Obs.: É importantíssimo persistir em seu banco de dados o ID da Conta retornado na resposta da requisição. Ele será usado caso seja preciso fazer alterações no cadastro da conta futuramente.

 

Exemplo de retorno com erro:

 

 

---

Cadastrando um Convênio

 

Assim como a conta, o cadastro do convênio irá fornecer informações para outros fluxos da aplicação. É nele que vamos configurar dados como carteira, CNAB, forma de registro, etc. Lembre-se que vamos precisar do campo id da conta que foi retornado na requisição anterior. Isso acontece pois um cedente pode ter várias contas, e é através desse ID que vinculamos esse novo convênio à conta correta.

 

POST

 Homologação:

 Produção:

 

Headers

 

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

 

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

 

Body

 

Campo	Tipo	Descrição
ConvenioNumero	string	Número do convênio
ConvenioDescricao	string	Descrição do convênio
ConvenioCarteira	string	Número da carteira
carteira_codigo	string	Campo opcional. Aceito apenas no CNAB 240 Valores aceitos: 1 = Cobrança Simples 2 = Cobrança Vinculada 3 = Cobrança Caucionada 4 = Cobrança Descontada 5 = Cobrança Vendor
ConvenioEspecie	string	Espécie do convênio
ConvenioPadraoCNAB	string	Padrão CNAB. Informar 240 ou 400
ConvenioReiniciarDiariamente	boolean	Define se o número atual da remessa será reiniciado diariamente.
ConvenioNumeroRemessa	string	Número atual da remessa. Campo obrigatório para Sicredi
Conta	integer	Identificador da conta na nossa base de dados. O campo "id" será disponibilizado a você no json de retorno da rota de cadastro da conta.
ConvenioDensidaDeRemessa	string	Código de Densidade da remessa (verificar a necessidade de preenchimento na seção "Dicas de preenchimento"). Preencher com 1600 ou 6250, conforme orientação do banco.
ConvenioRegistroInstantaneo	boolean	Define se o convênio irá ou não utilizar a transmissão instantânea.
ConvenioApiId	string	Campo utilizado para a transmissão instantânea, dúvida de como preencher clique aqui
ConvenioApiKey	string	Campo utilizado para a transmissão instantânea, dúvida de como preencher clique aqui
ConvenioApiSecret	string	Campo utilizado para a transmissão instantânea, dúvida de como preencher clique aqui
ConvenioEstacao	string	Campo utilizado para a transmissão instantânea, dúvida de como preencher clique aqui
ConvenioNossoNumeroBanco	boolean	true (verdadeiro) ou false (falso). Define se o Nosso Numero será controlado pelo banco. (Carteira Escritural)
ConvenioNossoNumeroConciliarBanco	boolean	true (verdadeiro) ou false (falso). Define a forma como os retornos serão conciliados de acordo com o preenchimento do TituloNossoNumero no arquivo de retorno.  Ex: Ex: Se o retorno não contiver o TituloNossoNumero informado pelo banco, você pode desabilitar a conciliação configurando a opção "ConvenioNossoNumeroConciliarBanco" como false ou desabilitando-a por meio da interface do PlugBoleto. Documentação: Carteira Escritural
Conveniotipowebservice	string	Campo utilizado para registro instantâneo do banco do brasil, para que seja possível escolher a versão da API a ser utilizada pelo banco. Valores aceitos v1, v2, v2.2* e v3**.   Caso o convênio seja do Bradesco, as opções aceitas são: NORMAL ou SHOP FACIL. O tipo do WS é definido pelo banco, no momento da liberação do serviço. *Somente Sicoob **Somente Sicredi
ConvenioConsultaws	Boolean	Define se estará realizando as consultas dos boletos emitidos via WS ( Será possível desativar apenas para os bancos: Bradesco(237), Caixa(104) e Sicoob(756))
ConvenioNumeroContrato	string	Campo utilizado para informar o "número de contrato" da conta caso o banco Banrisul exija este campo presente na remessa.   Disponível apenas no CNAB 240.
ConvenioVersaoLayoutArquivo	string	Versão do layout que deseja utilizar do banco (opcional)
ConvenioAlteracaoWebservice	Boolean	Campo utilizado para informar se irá utilizar o serviço de alteração de boletos via WebService   Disponível apenas para o banco ( Itaú v2 )

Dica: Para auxiliar no cadastro do convênio, possuímos uma seção de dicas, onde você encontra um detalhamento sobre as informações que devem ser preenchidas para cada banco.

Segue o link desta documentação: https://atendimento.tecnospeed.com.br/hc/pt-br/sections/360002897054-Dicas-para-cadastro-de-contas-e-conv%C3%AAnios

 

 

Exemplo:

{
  "ConvenioNumero": "7889604745",
  "ConvenioDescricao": "Convenio da tecnospeed",
  "ConvenioCarteira": "109",
  "ConvenioEspecie": "R$",
  "ConvenioPadraoCNAB": "400",
  "ConvenioNumeroRemessa": "1",
  "ConvenioReiniciarDiariamente": false,
  "Conta": 168
}

 

Retorno

 

Exemplo de retorno:

 

 

Obs.: É importantíssimo persistir em seu banco de dados o ID do Convênio retornado na resposta da requisição. Ele será usado caso seja preciso fazer alterações no cadastro do convênio futuramente.

 

Exemplo de retorno com erro:

 

 

 

 

---

 

Bancos homologados pela API PlugBoleto

 

Para uma lista completa dos bancos/CNAB's já homologados pela API PlugBoleto, acesse o link : Bancos Homologados.

 

---

 

Entendendo o modo de registro Manual, Automático, WebService e o Misto

 

O PlugBoleto da Tecnospeed trabalha com 3 formas de fazer o registro de seus boletos junto ao banco. 

Modo de registro: Transmissão Manual

 

Esta é a forma mais básica para registrar seus títulos no banco e conciliar os retornos.

Nela, seu cliente será responsável por emitir o boleto, gerar a remessa e encaminhá-la ao banco, e no dia seguinte baixar, o arquivo de retorno com as informações sobre a conciliação dos títulos e encaminhar este arquivo para o PlugBoleto, para que os títulos sejam conciliados (atualizados em nosso banco de dados).

Abaixo, um infográfico mostrando detalhes sobre como esta forma de registro funciona:

 

 

Modo de registro: Transmissão Automática (via VAN bancária)

 

Esta é a forma onde a Tecnospeed será a responsável pelo tráfego de arquivos ao banco. Nesta forma de transmissão seu cliente emite os boletos e solicita a remessa.

A partir deste momento, a transmissão do arquivo ao banco e recepção do arquivo de retorno após o processamento bancário é feito automaticamente pela Tecnospeed, e você pode configurar os Webhooks para receber alertas sempre que um boleto for atualizado pelo banco.

É importante ressaltar que o funcionamento deste recurso depende de uma liberação prévia da conta com o banco e com a própria Tecnospeed. Nesta seção explicamos com detalhes este processo. 

Abaixo, segue também um infográfico mostrando a lógica desta forma de comunicação com os bancos:

 

 

 

Modo de registro: Registro instantâneo via WebService bancário

 

Neste forma de registro ocorre uma comunicação entre os Webservices da Tecnospeed e os Webservices bancários, visando encaminhar ao banco as informações dos boletos no momento em que eles são emitidos, e assim, registrar os boletos instantaneamente.

Clique aqui para visualizar a documentação completa sobre este recurso.

Desta forma, o registro dos boletos ocorre no ato da emissão (use a rota de Consulta para identificar se um boleto foi Registrado ou Rejeitado pelo banco). Ou seja, o pagador não precisará aguardar diversas horas (e as vezes até 1 dia útil) para poder pagar os títulos. Obtendo o retorno positivo do banco, o boleto já poderá ser pago.

 

Para a grande maioria dos bancos é disponibilizada apenas a API para registro dos boletos, e não há API para a consulta. Por isso, recomendamos que o uso do Registro instantâneo ocorra juntamente com o uso da Transmissão Automática (descrita acima). Pois desta forma, o cliente poderá registrar seus boletos instantaneamente e receberá de forma automatizada os arquivos de retorno com as informações sobre o pagamento, baixas e demais instruções que vierem do banco.

 

Abaixo, o infográfico com a sequência lógica do funcionamento:

 

---

 

Modo de registro: Registro Misto (WebService + VAN) 

Neste forma de registro também ocorre uma comunicação entre os Webservices da Tecnospeed e os Webservices bancários, visando encaminhar ao banco as informações dos boletos no momento em que eles são emitidos, e assim, registrar os boletos instantaneamente. 

Contudo, essa modalidade utiliza a Transmissão Automática (via VAN bancária) para conciliar os retornos, que serão encaminhados via CNAB. Essa modalidade é bastante utilizada para bancos que não possuam a Consulta via WS** e também para bancos onde o Webservice não retorna alguns dados importantes na consulta, como por exemplo o campo "PagamentoDataCrédito", como exemplo o Itaú que o campo mencionado é retornado apenas nos envios e retornos via CNAB. 

 

Abaixo, o infográfico com a sequência lógica do funcionamento:

 

 

---

 

Fluxo ideal para a emissão de boletos

 

Tudo começa com a geração do tx2 ou do JSON em seu sistema

Em nossa integração, as informações do boleto podem ser passadas via "arquivo tx2" ou JSON , com campos padronizados. Ou seja, independente do banco, os campos do boleto terão o mesmo nome. É claro, existem particularidades entre bancos, como o Banco X exigir determinado campo, enquanto que o mesmo campo não é aceito pelo Banco Y. Mas estes são detalhes que vamos acertando no momento de homologar o boleto junto ao banco. O que importa é que com esta padronização, o esforço no desenvolvimento para homologar diferentes bancos fica muito reduzido!

*Neste link você tem acesso à listagem completa de campos disponíveis para montar seu boleto.

 

Vale lembrar que quando você integra pela ocx (componente instalado na máquina), a forma de gerar as informações do boleto é via "arquivo tx2" ; e se você optar por integrar via API, pode gerar as informações do boleto tanto em formato tx2 quanto em formato JSON!

 

E a partir daqui, esta é a sequencia do fluxo:

 

✔ 1º - "Inclusão do Boleto": Ou seja, é o momento que você pega o tx2 ou o JSON que seu sistema montou e envia para nossa API (via componente (ocx) ou diretamente via https). Nós recebemos este arquivo e te devolvemos um IdIntegracao, que é um ID único que vai identificar seu boleto em nosso sistema. Esse ID é importante porque para todo o restante do fluxo nós iremos utilizá-lo.

 

✔ 2º - Consultar o IdIntegracao: É o momento que consultamos o boleto em nosso banco de dados, para sabermos se se ele está com uma das seguintes situações:

 

Situação	Descrição
SALVO	Recebido pelo nosso sistema, porém ainda não processado completamente.
EMITIDO	Boleto gravado e validado em nosso sistema.
FALHA	Algum erro ocorreu na emissão, é preciso verificar a mensagem de erro e ajustar o tx2.
REGISTRADO	Esta situação pode ser retornada após a emissão do boleto, se utilizada a modalidade de registro via WebService Bancário (Na modalidade de registro via WebService não se faz necessário gerar a remessa para registro.).

 

✔ 3º - Solicitar a impressão: Nosso processo de impressão em lote (vários IdIntegracao juntos) é assíncrono. Então, aqui você repassa para o componente a lista de idIntegracao (separados por vírgula), e nós te devolvemos o protocolo de impressão, que será consultado logo em seguida;

 

✔ 3.1 e 3.2 - Imprimir ou Gerar o PDF: Então, usando o protocolo de impressão que acabamos de obter, chamamos os métodos de impressão ou geração do PDF do boleto;

 

✔ 4º - Gerar a remessa: Ainda usando o IdIntegracao, este método ao ser chamado devolve o conteúdo da remessa (no caso da transmissão manual); ou solicita para nossa API gerar o arquivo de remessa direto para o banco (no caso da transmissão automática);

 

✔ 5º e 5.1 (Apenas para a transmissão manual): O 5º passo recebe o arquivo de retorno que veio do banco e retorna um protocolo; e o passo 5.1 recebe este protocolo e retorna a lista dos IdIntegracao que foram atualizados com o arquivo de retorno. Também é uma operação assíncrona

E por último: basta consultar os IdIntegracao que voltaram no passo 5.1 ou os IdIntegracao que foram gerados na remessa (passo 4), para saber se os boletos mudaram de situação, de "Emitido" para "Registrado" , ou de "Registrado" para "Liquidado" por exemplo.

 

Depois que o boleto volta do banco, tanto na forma automática quanto da forma manual, é preciso repetir a consulta (a mesma apresentada no 2º passo desta documentação), para que você consiga identificar qual foi o resultado do processamento bancário de seus boletos.

Como retorno desta consulta, os boletos poderão apresentar também as  seguintes situações:

 

Situação	Descrição
Rejeitado	O banco processou o boleto, porém, o rejeitou.
Registrado	O banco processou e aceitou o Registro do boleto.
Liquidado	Cliente pagou o boleto e o banco nos enviou a informação da liquidação do título.
Baixado	O banco processou e aceitou a Baixa do boleto.

 

 

Para facilitar a compreensão, segue também o modelo com a sequência de fluxos:

 

Vale lembrar que além destes métodos modelados acima, temos também diversos outros métodos, incluindo:

• Personalização de impressão;
• Notificações via Webhook
• Envio de email único ou em lote;
• Descarte de boletos;
• Notificações automáticas por email e SMS;
• Remessas de Alteração e Baixa;

---

 

Rotas da API

 

No link a seguir, temos uma lista das principais rotas de emissão com o PlugBoleto:

https://atendimento.tecnospeed.com.br/hc/pt-br/articles/27388984588823-Rotas-de-Emiss%C3%A3o