Skip to main content
Consulta os dados do registro de um boleto bancário.
Through this endpoint, the partner can consult the registration of a specific bill with the responsible body.

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> | null
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
dadosJuros
object | null
sacadorAvalista
object | null
dadosDesconto
object | null
dadosDescontos
object[] | null
dadosBaixa
object | null
hibrido
boolean
emv
string | null
imagem
string | null