56 - Consultar Registro de Boleto

Scopes:

api.ext api.boleto.consultarRegistro

Consulta os dados do registro de um boleto bancário.

cURL

curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro \
  --header 'Authorization: <api-key>'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numeroCedente": 123,
  "dtInclusao": "2023-11-07T05:31:56Z",
  "tpPessoaPagdr": "<string>",
  "cnpJ_CPFPagdr": "<string>",
  "nom_RzSocPagdr": "<string>",
  "nomFantsPagdr": "<string>",
  "logradPagdr": "<string>",
  "cidPagdr": "<string>",
  "ufPagdr": "<string>",
  "cepPagdr": "<string>",
  "codCartTit": "<string>",
  "codMoedaCNAB": "<string>",
  "identdNossoNum": "<string>",
  "numCodBarras": "<string>",
  "numLinhaDigtvl": "<string>",
  "dtVencTit": "2023-11-07T05:31:56Z",
  "vlrTit": 123,
  "numDocTit": "<string>",
  "numeroDocumento": "<string>",
  "codEspTit": "<string>",
  "dtEmsTit": "2023-11-07T05:31:56Z",
  "dtLimPgtoTit": "2023-11-07T05:31:56Z",
  "indrBloqPgto": "<string>",
  "vlrAbattTit": 123,
  "tpAutcRecbtVlrDivgte": "<string>",
  "dtMovto": "2023-11-07T05:31:56Z",
  "numIdentcTit": "<string>",
  "dtHrDDA": "2023-11-07T05:31:56Z",
  "codOperacaoCli": "<string>",
  "dtSituacao": "2023-11-07T05:31:56Z",
  "msgSituacao": "<string>",
  "dadosJuros": {
    "dtJurosTit": "2023-11-07T05:31:56Z",
    "codJurosTit": "<string>",
    "vlr_PercJurosTit": 123
  },
  "sacadorAvalista": {
    "identificador": "<string>",
    "nomeSacadorAvalista": "<string>"
  },
  "dadosDesconto": {
    "dtDesctTit": "2023-11-07T05:31:56Z",
    "codDesctTit": "<string>",
    "vlr_PercDesctTit": 123
  },
  "dadosDescontos": [
    {
      "dtDesctTit": "2023-11-07T05:31:56Z",
      "codDesctTit": "<string>",
      "vlr_PercDesctTit": 123
    }
  ],
  "dadosBaixa": {
    "dtCreditoBoleto": "2023-11-07T05:31:56Z",
    "codigoMovto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vlrBaixaOperacTit": 123,
    "dtHrDDA": "2023-11-07T05:31:56Z"
  },
  "hibrido": true,
  "emv": "<string>",
  "imagem": "<string>"
}

Por meio desse endpoint, o parceiro pode consultar o registro de um determinado boleto junto ao órgão responsável.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/Boleto/ConsultarRegistro	Parâmetro inválido
/api/Boleto/ConsultarRegistro	Somente um parâmetro deve ser informado
/api/Boleto/ConsultarRegistro	O código de barras não pode exceder 44 caracteres
/api/Boleto/ConsultarRegistro	Registro não encontrado
/api/Boleto/ConsultarRegistro	Registro não encontrado

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

CodigoRegistroBoleto · string<uuid>

Código UUID de registro do boleto.

Observação:

• Quando o 'código UUID de registro do boleto' (CodigoRegistroBoleto) for informado, o 'código de barras do boleto' (CodigoBarras) não deve ser preenchido.

CodigoBarras · string

Código de barras do boleto.

Observação:

• Quando o 'código de barras do boleto' (CodigoBarras) for informado, o 'código UUID de registro do boleto' (CodigoRegistroBoleto) não deve ser preenchido.

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null

codigo · string<uuid>

numeroCedente · integer<int64>

dtInclusao · string<date-time> | null

tpPessoaPagdr · string | null

cnpJ_CPFPagdr · string | null

nom_RzSocPagdr · string | null

nomFantsPagdr · string | null

logradPagdr · string | null

cidPagdr · string | null

ufPagdr · string | null

cepPagdr · string | null

codCartTit · string | null

codMoedaCNAB · string | null

identdNossoNum · string | null

numCodBarras · string | null

numLinhaDigtvl · string | null

dtVencTit · string<date-time> | null

vlrTit · number<double> | null

numDocTit · string | null

numeroDocumento · string | null

codEspTit · string | null

dtEmsTit · string<date-time> | null

dtLimPgtoTit · string<date-time> | null

indrBloqPgto · string | null

vlrAbattTit · number<double> | null

tpAutcRecbtVlrDivgte · string | null

dtMovto · string<date-time> | null

numIdentcTit · string | null

dtHrDDA · string<date-time> | null

codOperacaoCli · string | null

dtSituacao · string<date-time> | null

msgSituacao · string | null

situacaoBoleto · enum<integer>

Opções disponíveis: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

dadosJuros · object

Show child attributes

sacadorAvalista · object

Show child attributes

dadosDesconto · object

Show child attributes

dadosDescontos · object[] | null

Show child attributes

dadosBaixa · object

Show child attributes

hibrido · boolean

emv · string | null

imagem · string | null