50 - Check Boleto Registration

curl --request GET \
  --url https://api.bmpdigital.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>"
}

Through this endpoint, partners can check the registration of a specific boleto with the responsible entity.

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Query Parameters

CodigoRegistroBoleto

string

Código UUID de registro do boleto.

CodigoBarras

string

Código de barras do boleto.

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.

codigo

string

Código UUID identificador do boleto registrado.

numeroCedente

integer

Número único identificador do cedente.

dtInclusao

string | null

Data de inclusão do registro do boleto.

tpPessoaPagdr

string | null

Tipo de pessoa do pagador. F = Pessoa Física; J = Pessoa Jurídica.

cnpJ_CPFPagdr

string | null

CNPJ ou CPF do pagador.

nom_RzSocPagdr

string | null

Nome ou razão social do pagador.

nomFantsPagdr

string | null

Nome fantasia do pagador.

logradPagdr

string | null

Rua, número e complemento do pagador.

cidPagdr

string | null

Cidade do pagador.

ufPagdr

string | null

Sigla da unidade da federação do pagador.

cepPagdr

string | null

CEP do pagador.

codCartTit

string | null

Código Carteira Título. Código para identificar as características dos títulos dentro das modalidades de cobrança existentes no banco. 1 = Cobrança Simples; 2 = Cobrança Vinculada; 3 = Cobrança Caucionada; 4 = Cobrança Descontada; 5 = Cobrança Vendor; 6 = Cobrança Cessão

codMoedaCNAB

string | null

Código da Moeda no padrão CNAB. 01 = Reservado para uso futuro; 02 = Dólar Americano Comercial (Venda); 03 = Dólar Americano Turismo (Venda); 04 = ITRD

identdNossoNum

string | null

Número de Controle do Cedente para identificar o Título.

numCodBarras

string | null

Código de barras do Boleto de Pagamento.

numLinhaDigtvl

string | null

Linha digitável do Boleto de Pagamento.

dtVencTit

string | null

Data de vencimento do título.

vlrTit

number | null

Valor do Título.

numDocTit

string | null

Número do Documento do Título utilizado pelo Cedente.

numeroDocumento

string | null

Número do documento. Campo livre para uso interno do cliente.

codEspTit

string | null

Código para identificar o tipo de título de cobrança. Códigos adotados pela FEBRABAN. 1 = CH Cheque; 2 = DM Duplicata Mercantil; 3 = DMI Duplicata Mercantil Indicação; 4 = DS Duplicata de Serviço; 5 = DSI Duplicata de Serviço Indicação; 6 = DR Duplicata Rural; 7 = LC Letra de Câmbio; 8 = NCC Nota de Crédito Comercial; 9 = NCE Nota de Crédito Exportação; 10 = NCI Nota de Crédito Industrial; 11 = NCR Nota de Crédito Rural; 12 = NP Nota Promissória; 13 = NPR Nota Promissória Rural; 14 = TM Triplicata Mercantil; 15 = TS Triplicata de Serviço; 16 = NS Nota de Seguro; 17 = RC Recibo; 18 = FAT Bloqueto; 19 = ND Nota de Débito; 20 = AP Apólice de Seguro; 21 = ME Mensalidade Escolar; 22 = PC Parcela de Consórcio; 23 = NF Nota Fiscal; 24 = DD Documento de Dívida; 25 = Cédula de Produto Rural; 26 = Warrant; 27 = Dívida Ativa de Estado; 28 = Dívida Ativa de Município; 29 = Dívida Ativa da União; 30 = Encargos condominiais; 31 = Cartão de Crédito; 32 = Boleto proposta; 33 = Boleto de Depósito e Aporte; 99 = Outros

dtEmsTit

string | null

Data de emissão do título.

dtLimPgtoTit

string | null

Data limite para pagamento do título. Deve ser maior ou igual à data de vencimento da operação.

indrBloqPgto

string | null

Indicador de bloqueio do boleto de pagamento para pagamento. N = Não; S = Sim.

vlrAbattTit

number | null

Valor total dos abatimentos para o boleto de pagamento.

tpAutcRecbtVlrDivgte

string | null

Tipo de autorização do cliente beneficiário ou do participante destinatário para recebimento de valor divergente para instruir o participante recebedor. 1 = Qualquer valor; 2 = Entre o mínimo e o máximo; 3 = Não aceitar pagamento com valor divergente; 4 = Somente valor mínimo

dtMovto

string | null

Data de movimento.

numIdentcTit

string | null

Número de identificação do Boleto de Pagamento.

dtHrDDA

string | null

Data Hora do DDA.

codOperacaoCli

string | null

dtSituacao

string | null

Data da situação atual.

msgSituacao

string | null

Situação no formato de texto.

situacaoBoleto

enum<integer>

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

9,

10

dadosJuros

object

Dados referentes à juros.

sacadorAvalista

object

Dados referentes ao sacador avalista.

dadosDesconto

object

Dados referentes ao desconto.

dadosDescontos

object[] | null

dadosBaixa

object

Dados referentes à baixa do título.

hibrido

boolean

Indicador se o boleto é híbrido.

emv

string | null

EMV para boletos híbridos. Conteúdo do QR Code.

imagem

string | null

Imagem do QRCode codificada em Base64. Presente em boletos híbridos.

Was this page helpful?

49 - Register Bankslip 51 - Check Registered Boletos

curl --request GET \
  --url https://api.bmpdigital.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>"
}

Initial Guide

Developer's Guide

APIs Reference

50 - Check Boleto Registration

Authorizations

Query Parameters

Response