Pular para o conteúdo principal
GET
/
api
/
Boleto
/
ConsultarRegistro
Consulta os dados do registro de um boleto bancário.
curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro \
  --header 'Authorization: <api-key>'
{
  "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>",
  "situacaoBoleto": 1,
  "dadosJuros": {
    "dtJurosTit": "2023-11-07T05:31:56Z",
    "codJurosTit": "<string>",
    "vlr_PercJurosTit": 123
  },
  "sacadorAvalista": {
    "tipo": 0,
    "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.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
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.

Response

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
​
sacadorAvalista
object
​
dadosDesconto
object
​
dadosDescontos
object[] | null
​
dadosBaixa
object
​
hibrido
boolean
​
emv
string | null
​
imagem
string | null