Blog

Registrando boleto via WebService (On-line)

Algumas instituições financeiras disponibilizam o registro de boleto via WebService, para trabalhar com esta modalidade.

Inicializando a comunicação

O fluxo geral de comunicação com o banco segue a seguinte lógica:

  1. Boleto – WebService – Inicializar – Fornece os dados básicos para comunicação com o banco;
  2. Boleto – WebService – Incluir Boleto – Permite o envio de um boleto para a conexão previamente estabelecida, podendo ser chamadas repetidas vezes para a mesma conexão.

Não se faz necessário ‘desconectar’ ou deslogar. A conexão retornada pela inicialização pode ser reutilizado por uma janela de tempo determinada pelo banco (normalmente até 04 horas), recomendamos que use durante a execução de um fluxo (5 min). Não tentando salvar na sessão para uso posterior.

Enviado/Cadastrando um novo boleto

  1. Boleto – WebService – Inicializar – Inicie a comunicação com o banco;
  2. Boleto – WebService – Incluir Boleto(Conexão, Dados boleto) – Envie um boleto para a conexão previamente estabelecida, podendo ser chamadas repetidas vezes para a mesma conexão
    • Conexão é a variante retornada pela inicialização;
    • Dados boleto (Variante) é um mapa contendo os mesmos itens usados na geração do PDF e remessa (veja aqui).
  3. O retorno do envio será um mapa (variante) com os seguintes itens:
    • Em todos os casos retornará:
      • “SUCESSO” (Lógico) indicando se a operação foi executada com sucesso ou não;
      • “SERVIDOR_RESPOSTA” (Letras) – Com o texto completo da resposta retornada pelo servidor;
      • “SITUACAO_DESCRICAO” (Letras) – Indicando o resultado geral da chamada (se houver).
    • Em caso de sucesso também retornará:
      • “CODIGO_BARRAS”
      • “LINHA_DIGITAVEL”
      • “NOSSO_NUMERO”
      • “BOLETO_URL” – Link para visualização do boleto on-line.
    • Em caso de erro serão retornados os seguintes itens:
      • “ERRO_MENSAGEM” – Mensagem de erro retornada pelo servidor.

Observações

Nem todo banco/carteira disponibiliza todos os métodos, alguns permitem o envio (cadastro), mas não disponibilizam métodos de alteração, cancelamento ou baixa. O mesmo vale para a consulta da situação do boleto.

Leave a comment