ACBrLibBoleto (C#) - Integração para recuperar retorno via API (BB)

[SWAPI]

Olá, boa tarde!

Olhando a documentação do ACBrLibBoleto eu não vi um método que seja uma integração via API para listar retornos (que seria uma alternativa ao ler arquivo retorno). No Banco do Brasil tem o endpoint /cobrancas/v2/convenios/{convenio}/listar-retorno-movimento que retorna, em JSON, o que seria o arquivo retorno, com todos as propriedades que tem em um.

Gostaríamos de saber se existe uma pretensão de implementar essa integração na lib. Seria muito bom para a gente, e se ele funcionar como o ObterRetorno que, no C# retorna os dados num objeto RetornoBoleto.

Segue link onde pode ser visto o endpoint com exemplo de requisição e resposta, fica na seção "movimento": https://apoio.developers.bb.com.br/sandbox/spec/5f4e6f6cb71fb5001268c96a

Desde já agradeço.

[Júlio Cavalcanti]

Bom dia, @SWAPI. Apenas para confirmar, você deseja um método para retornar o JSON diretamente?

[Daniel InfoCotidiano]

No BB atualmente temos a consulta detalhada por boleto TpConsultaDetalhe e a Consulta em lista TpConsulta que devolve uma lista de boletos de acordo com filtros.
Exemplo:
indicadorSituacao, carteira, modalidadeCobranca, periodo ETC
Esta consulta em lista, vc chegou a testar ?
 

[SWAPI]

Bom dia!

@Daniel InfoCotidiano infelizmente não nos ajudam, o de detalhes não é o nosso foco pela funcionalidade que estamos colocando no sistema, que é receber os retornos do dia e dar baixa nos boletos no nosso sistema. O de consulta que devolve a lista não tem todos os dados que precisamos, como o juros pago, por exemplo.

@Júlio Cavalcanti não, o ideal seria que retornasse da mesma forma que o método ObterRetorno retorna.

[Daniel InfoCotidiano]

  Em 26/03/2025 at 14:14, SWAPI disse:

O de consulta que devolve a lista não tem todos os dados que precisamos, como o juros pago, por exemplo.

Expandir  

ja questionou o suporte banco sobre estas informações que não esta voltando na consulta ?

[SWAPI]

Na verdade as funcionalidades são diferentes para cada um dos endpoints.

O endpoint /cobrancas/v2/boletos vai retorna uma lista de boletos registrados e o que estamos comentando é /cobrancas/v2/convenios/{convenio}/listar-retorno-movimento 

A função do primeiro é retornar boletos registrados e não o espelho do arquivo de retorno e por isso tem muito menos informação para cada título, sendo apenas as informações de envio:
/cobrancas/v2/boletos

[
  {
    "indicadorContinuidade": "s",
    "quantidadeRegistros": 300,
    "proximoIndice": 300,
    "boletos": [
      {
        "numeroBoletoBB": "00024589070000000412",
        "estadoTituloCobranca": "Mvto. Cartorio",
        "dataRegistro": "01.05.2020",
        "dataVencimento": "01.05.2020",
        "dataMovimento": "01.05.2020",
        "valorOriginal": 1000,
        "valorAtual": 10000,
        "valorPago": 9000,
        "contrato": 0,
        "carteiraConvenio": 17,
        "variacaoCarteiraConvenio": 27,
        "codigoEstadoTituloCobranca": 1,
        "dataCredito": "01.05.2020"
      }
    ]
  }
]

Já o segundo, /cobrancas/v2/convenios/{convenio}/listar-retorno-movimento, tem a função de retornar os registros da mesma forma que o arquivo de retorno, que é baixado do banco, para processamento usando o método ObterRetorno passando o arquivo baixado através do gerenciador. 

Percebam que o retorno desse método é realmente para ser utilizado para realizar a baixa da mesma forma que é feito utilizando arquivos de retorno do banco.
 

{
  "indicadorContinuidade": "S",
  "numeroUltimoRegistro": 8900,
  "listaRegistro": [
    {
      "dataMovimentoRetorno": "24.03.2022",
      "numeroConvenio": 1234567,
      "numeroTituloCobranca": "00012345670000000001",
      "codigoComandoAcao": 2,
      "codigoPrefixoAgencia": 1,
      "numeroContaCorrente": 123456789,
      "numeroCarteiraCobranca": 17,
      "numeroVariacaoCarteiraCobranca": 35,
      "tipoCobranca": 1,
      "codigoControleParticipante": "A123456",
      "codigoEspecieBoleto": 0,
      "dataVencimentoBoleto": "31.12.2022",
      "valorBoleto": 100,
      "codigoBancoRecebedor": 237,
      "codigoPrefixoAgenciaRecebedora": 2,
      "dataCreditoPagamentoBoleto": "03.02.2023",
      "valorTarifa": 9,
      "valorOutrasDespesasCalculadas": 0,
      "valorJurosDesconto": 1,
      "valorIofDesconto": 0.5,
      "valorAbatimento": 10,
      "valorDesconto": 1,
      "valorRecebido": 100,
      "valorJurosMora": 5,
      "valorOutrosValoresRecebidos": 2,
      "valorAbatimentoNaoUtilizado": 1,
      "valorLancamento": 30,
      "codigoFormaPagamento": 0,
      "codigoValorAjuste": 0,
      "valorAjuste": 0.51,
      "codigoAutorizacaoPagamentoParcial": 1,
      "codigoCanalPagamento": 11,
      "URL": "qrcode.sed.desenv.bb.com.br/pix/v2/cobv/ce8a678e-0a0c-414e-938a-88dc072708a0",
      "textoIdentificadorQRCode": "BOLETO19221240800005487DATA17012022 ",
      "quantidadeDiasCalculo": 12,
      "valorTaxaDesconto": 0.33,
      "valorTaxaIOF": 1.2323,
      "naturezaRecebimento": 7,
      "codigoTipoCobrancaComando": 0,
      "dataLiquidacaoBoleto": "dd.mm.aaaa"
    }
  ]
}

Dessa forma é necessário a implementação desse endpoint para baixar esses registros para posterior utilização.

Imaginamos que o fluxo poderia ser da seguintes forma:
  1 - seria chamado esse novo método que seria responsável para baixar o retorno do banco, acabando com a necessidade do cliente ir no gerenciador baixar o arquivo;
  2 - ao ser utilizado o método ObterRetorno (Boleto_ObterRetorno) o arquivo passado seria esse arquivo da mesma forma que é passado o arquivo atual baixado no gerenciador;
  3 - como esse arquivo tem estrutura diferente o ObterRetorno iria verificar a estrutura do arquivo enviado e saberia como tratar, forma antiga ou novo json;

 Espero ter explicado bem a necessidade desse novo método. Lembrando que para a utilização desse endpoint é necessário, ainda, uma liberação especial do gerente da conta do cliente no BB.

Att,

[Daniel InfoCotidiano]

Criado a tarefa TK-6817 para análise do time de boleto.
Assim que analisado será notificado aqui mesmo no forum

[SWAPI]

Olá pessoal,

Algum retorno sobre isso? Agradeço.

[Daniel InfoCotidiano]

Boa tarde !
Ainda está em nosso backlog devido ao grande fluxo de implementações e analise.
Acredito que em breve ja entre para analise. reportamos aqui assim q iniciar