{"id":1410,"date":"2019-07-28T20:17:28","date_gmt":"2019-07-28T23:17:28","guid":{"rendered":"http:\/\/www.l2maker.com.br\/documentacao\/?p=1410"},"modified":"2024-06-26T13:15:15","modified_gmt":"2024-06-26T16:15:15","slug":"registrando-boleto-via-webservice-on-line","status":"publish","type":"post","link":"https:\/\/www.l2maker.com.br\/documentacao\/2019\/07\/registrando-boleto-via-webservice-on-line\/","title":{"rendered":"Registrando boleto via WebService (On-line)"},"content":{"rendered":"<p>Algumas institui\u00e7\u00f5es financeiras disponibilizam o registro de boleto via WebService, para trabalhar com esta modalidade.<\/p>\n<h2>Inicializando a comunica\u00e7\u00e3o<\/h2>\n<p>O fluxo geral de comunica\u00e7\u00e3o com o banco segue a seguinte l\u00f3gica:<\/p>\n<ol>\n<li><strong>Boleto &#8211; WebService &#8211; Inicializar<\/strong> &#8211; Fornece os dados b\u00e1sicos para comunica\u00e7\u00e3o com o banco;<\/li>\n<li><strong>Boleto &#8211; WebService &#8211; Incluir Boleto<\/strong> &#8211; Permite o envio de um boleto para a conex\u00e3o previamente estabelecida, podendo ser chamadas repetidas vezes para a mesma conex\u00e3o.<\/li>\n<\/ol>\n<p>N\u00e3o se faz necess\u00e1rio &#8216;desconectar&#8217; ou deslogar. A conex\u00e3o retornada pela inicializa\u00e7\u00e3o pode ser reutilizado por uma janela de tempo determinada pelo banco (normalmente at\u00e9 04 horas), recomendamos que use durante a execu\u00e7\u00e3o de um fluxo (5 min). N\u00e3o tentando salvar na sess\u00e3o para uso posterior.<\/p>\n<h2>Enviado\/Cadastrando um novo boleto<\/h2>\n<ol>\n<li><strong>Boleto &#8211; WebService &#8211; Inicializar<\/strong> &#8211; Inicie a comunica\u00e7\u00e3o com o banco;<\/li>\n<li><strong>Boleto &#8211; WebService &#8211; Incluir Boleto(Conex\u00e3o, Dados boleto)<\/strong> &#8211;\u00a0<strong>Envie um boleto para a conex\u00e3o previamente estabelecida, podendo ser chamadas repetidas vezes para a mesma conex\u00e3o<\/strong>\n<ul>\n<li>Conex\u00e3o \u00e9 a variante retornada pela inicializa\u00e7\u00e3o;<\/li>\n<li>Dados boleto (Variante) \u00e9 um mapa contendo os mesmos itens usados na gera\u00e7\u00e3o do PDF e remessa (<a href=\"https:\/\/www.l2maker.com.br\/documentacao\/2015\/10\/parametros-do-boleto-bancario\/\">veja aqui<\/a>).<\/li>\n<\/ul>\n<\/li>\n<li>O retorno do envio ser\u00e1 um mapa (variante) com os seguintes itens:\n<ul>\n<li>Em todos os casos retornar\u00e1:\n<ul>\n<li>&#8220;SUCESSO&#8221; (L\u00f3gico) indicando se a opera\u00e7\u00e3o foi executada com sucesso ou n\u00e3o;<\/li>\n<li>&#8220;SERVIDOR_RESPOSTA&#8221; (Letras) &#8211; Com o texto completo da resposta retornada pelo servidor;<\/li>\n<li>&#8220;SITUACAO_DESCRICAO&#8221; (Letras) &#8211; Indicando o resultado geral da chamada (se houver).<\/li>\n<\/ul>\n<\/li>\n<li>Em caso de sucesso tamb\u00e9m retornar\u00e1:\n<ul>\n<li>&#8220;CODIGO_BARRAS&#8221;<\/li>\n<li>&#8220;LINHA_DIGITAVEL&#8221;<\/li>\n<li>&#8220;NOSSO_NUMERO&#8221;<\/li>\n<li>&#8220;BOLETO_URL&#8221; &#8211; Link para visualiza\u00e7\u00e3o do boleto on-line.<\/li>\n<\/ul>\n<\/li>\n<li>Em caso de erro ser\u00e3o retornados os seguintes itens:\n<ul>\n<li>&#8220;ERRO_MENSAGEM&#8221; &#8211; Mensagem de erro retornada pelo servidor.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<h2>Consultando\/Verificando a situa\u00e7\u00e3o de boleto<\/h2>\n<p>Para saber se um boleto est\u00e1 pago, pendente ou cancelado voc\u00ea deve usar a fun\u00e7\u00e3o &#8220;<strong>Boleto &#8211; WebService &#8211; Consultar Boleto<\/strong>&#8221; com os seguintes par\u00e2metros:<\/p>\n<ol>\n<li>Conex\u00e3o (Variante) retornada pela inicializa\u00e7\u00e3o;<\/li>\n<li>Dados do boleto a ser consultado. Pode variar para cada banco (ver na documenta\u00e7\u00e3o espec\u00edfica do banco), normalmente deve conter os seguintes dados:\n<ul>\n<li><strong>NOSSO_NUMERO<\/strong>;<\/li>\n<li><strong>LINHA_DIGITAVEL<\/strong>;<\/li>\n<li><strong>CODIGO_BARRAS<\/strong>;<\/li>\n<li><strong>BOLETO_GERAR_PDF<\/strong> (L\u00f3gico): Se for informado como verdadeiro, e o banco suportar, ser\u00e1 baixado o PDF do boleto gerado pelo banco. O PDF ser\u00e1 retornado no item &#8216;<strong>ARQUIVO_PDF<\/strong>&#8216;.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p>No retorna da fun\u00e7\u00e3o vir\u00e1 os dados do(s) boleto(s) consultados, em um mapeamento contendo entre outros, os seguintes itens:<\/p>\n<ul>\n<li><strong>BOLETO_SITUACAO<\/strong> (Letras): Indica se o boleto est\u00e1 &#8220;<strong>EM ABERTO<\/strong>&#8221; (Aguardando pagamento), &#8220;<strong>BAIXADO<\/strong>&#8221; (Removido do sistema), &#8220;<strong>LIQUIDADO<\/strong>&#8221; (pago);<\/li>\n<li>&#8220;<strong>PIX_QRCODE<\/strong>&#8221; (Letras): Dados do PIX conjugado ao boleto (se houver);<\/li>\n<li>&#8220;<strong>PIX_TXID<\/strong>&#8221; (Letras): Dados do PIX conjugado ao boleto (se houver);<\/li>\n<li>&#8220;<strong>ITENS<\/strong>&#8221; (Lista\/Variante): Quando a requisi\u00e7\u00e3o retornar mais de um boleto, cada um deles est\u00e1 nos mapeamentos desta lista.<\/li>\n<\/ul>\n<h2>Observa\u00e7\u00f5es<\/h2>\n<p>Nem todo banco\/carteira disponibiliza todos os m\u00e9todos, alguns permitem o envio (cadastro), mas n\u00e3o disponibilizam m\u00e9todos de altera\u00e7\u00e3o, cancelamento ou baixa. O mesmo vale para a consulta da situa\u00e7\u00e3o do boleto.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Algumas institui\u00e7\u00f5es financeiras disponibilizam o registro de boleto via WebService, para trabalhar com esta modalidade. Inicializando a comunica\u00e7\u00e3o O fluxo geral de comunica\u00e7\u00e3o com o banco segue a seguinte l\u00f3gica: Boleto &#8211; WebService &#8211; Inicializar &#8211; Fornece os dados b\u00e1sicos para comunica\u00e7\u00e3o com o banco; Boleto &#8211; WebService &#8211; Incluir Boleto &#8211; Permite o envio [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[90],"tags":[],"class_list":["post-1410","post","type-post","status-publish","format-standard","hentry","category-remessa-e-retorno"],"_links":{"self":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts\/1410","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/comments?post=1410"}],"version-history":[{"count":12,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts\/1410\/revisions"}],"predecessor-version":[{"id":3569,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts\/1410\/revisions\/3569"}],"wp:attachment":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/media?parent=1410"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/categories?post=1410"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/tags?post=1410"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}