{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoRetorno": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dadosTitulo": {
    "numLinhaDigtvl": "<string>",
    "numCodBarras": "<string>",
    "nomFantsBenfcrioOr": "<string>",
    "dtVencTit": "2023-11-07T05:31:56Z",
    "cnpjCpfBenfcrioOr": "<string>",
    "vlrTit": 123,
    "tpPessoaBenfcrioOr": "<string>",
    "codPartDestinatario": "<string>",
    "numIdentcTit": "<string>",
    "numRefAtlCadTit": "<string>",
    "indrPgtoParcl": "<string>",
    "tpAutcRecbtVlrDivgte": "<string>",
    "codEspTit": 123,
    "numCtrlPart": "<string>",
    "ispbPartRecbdrPrincipal": "<string>",
    "ispbPartRecbdrAdmtd": "<string>",
    "numCtrlDDA": "<string>",
    "numSeqAtlzCadTit": "<string>",
    "dtHrSitTit": "2023-11-07T05:31:56Z",
    "ispbPartDestinatario": "<string>",
    "nomRzSocBenfcrioOr": "<string>",
    "tpPessoaPagdr": "<string>",
    "cnpjCpfPagdr": "<string>",
    "nomRzSocPagdr": "<string>",
    "codMoedaCNAB": "<string>",
    "dtLimPgtoTit": "2023-11-07T05:31:56Z",
    "indrBloqPgto": "<string>",
    "vlrAbattTit": 123,
    "tpModlCalc": "<string>",
    "sitTitPgto": "<string>",
    "dtHrDDA": "2023-11-07T05:31:56Z",
    "dtMovto": "2023-11-07T05:31:56Z",
    "tpVlr_PercMinTit": "<string>",
    "vlr_PercMinTit": 123,
    "tpVlr_PercMaxTit": "<string>",
    "vlr_PercMaxTit": 123,
    "totalBaixasParciais": 123,
    "tpIdentcSacdrAvalst": "<string>",
    "identcSacdrAvalst": "<string>",
    "nom_RzSocSacdrAvalst": "<string>",
    "emissor": "<string>",
    "result": 123,
    "tipo": 1
  },
  "juros": {
    "codJurosTit": "<string>",
    "dtJurosTit": "2023-11-07T05:31:56Z",
    "vlrPercJurosTit": 123,
    "total": 123
  },
  "multa": {
    "codMultaTit": "<string>",
    "dtMultaTit": "2023-11-07T05:31:56Z",
    "vlrPercMultaTit": 123,
    "total": 123
  },
  "descontos": [
    {
      "codDesctTit": "<string>",
      "dtDesctTit": "2023-11-07T05:31:56Z",
      "vlrPercDesctTit": 123,
      "total": 123
    }
  ],
  "validacoes": [
    {
      "mensagem": "<string>"
    }
  ],
  "sucessoRetornoCM": true,
  "origemConsulta": 1,
  "vlrTitTotal": 123
}
Por meio deste endpoint, o parceiro pode realizar uma consulta de boletos que possuem registro em outra instituição financeira.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
LinhaDigitavel
string

Sequência numérica digitável presente no boleto bancário.

​
CodigoBarras
string

Sequência numérica que corresponde ao código de barras impresso no boleto bancário.

Response

200 - application/json

Success

​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
codigoRetorno
string<uuid>

C�digo UUID identificador do boleto consultado. Diferente do c�digo de registro do boleto.

​
dadosTitulo
object

Dados referentes ao boleto.

​
juros
object

Dados referentes � juros.

​
multa
object

Dados referentes � multa.

​
descontos
object[] | null

Lista de dados referentes � descontos.

​
validacoes
object[] | null

Lista de valida��es.

​
sucessoRetornoCM
boolean

Indicativo de sucesso na comunica��o com a CM.

​
origemConsulta
enum<integer>

1 = CM; 2 = SWAP

Available options:
1,
2
​
vlrTitTotal
number

Valor total do t�tulo, calculado subtraindo os abatimentos e baixas parciais do valor original, somando os juros e multas, e subtraindo os descontos.