55 - Check Modifications

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alteracoes": [
    {
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoCedenteCarteira": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "origemRegistro": 123,
      "codMsg": "<string>",
      "dtInclusao": "2023-11-07T05:31:56Z",
      "codigoAcesso": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoOperador": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "numCtrlPart": "<string>",
      "ispbPartDestinatarioPrincipal": "<string>",
      "ispbPartDestinatarioAdmtd": "<string>",
      "numIdentcTit": "<string>",
      "numRefAtlCadTit": "<string>",
      "indrManutBenfcrioOr": "<string>",
      "nomFantsBenfcrioOr": "<string>",
      "logradBenfcrioOr": "<string>",
      "cidBenfcrioOr": "<string>",
      "ufBenfcrioOr": "<string>",
      "cepBenfcrioOr": "<string>",
      "indrManutBenfcrioFinl": "<string>",
      "tpPessoaBenfcrioFinl": "<string>",
      "cnpJ_CPFBenfcrioFinl": "<string>",
      "nom_RzSocBenfcrioFinl": "<string>",
      "nomFantsBenfcrioFinl": "<string>",
      "indrManutPagdrTit": "<string>",
      "nom_RzSocPagdr": "<string>",
      "nomFantsPagdr": "<string>",
      "logradPagdr": "<string>",
      "cidPagdr": "<string>",
      "ufPagdr": "<string>",
      "cepPagdr": "<string>",
      "indrManutSacdrAvalst": "<string>",
      "tpIdentcSacdrAvalst": "<string>",
      "identcSacdrAvalst": "<string>",
      "nom_RzSocSacdrAvalst": "<string>",
      "indrManutDocTit": "<string>",
      "codCartTit": "<string>",
      "codEspTit": "<string>",
      "numDocTit": "<string>",
      "tpPgtoTit": "<string>",
      "numParcl": 123,
      "qtdTotParcl": 123,
      "indrTitNegcd": "<string>",
      "indrManutInstcPgtoTit": "<string>",
      "dtVencTit": "2023-11-07T05:31:56Z",
      "vlrTit": 123,
      "qtdDiaPrott": 123,
      "dtLimPgtoTit": "2023-11-07T05:31:56Z",
      "indrBloqPgto": "<string>",
      "vlrAbattTit": 123,
      "qtdPgtoParcl": 123,
      "tpModlCalc": "<string>",
      "indrManutInstcVlrRecbt": "<string>",
      "tpAutcRecbtVlrDivgte": "<string>",
      "tpVlr_PercMinTit": "<string>",
      "vlr_PercMinTit": 123,
      "tpVlr_PercMaxTit": "<string>",
      "vlr_PercMaxTit": 123,
      "indrManutJurosTit": "<string>",
      "indrManutMultaTit": "<string>",
      "indrManutDesctTit": "<string>",
      "indrManutHistNotaFis": "<string>",
      "indrManutHistTxtInf": "<string>",
      "txtInfBenfcrio": "<string>",
      "dtMovto": "2023-11-07T05:31:56Z",
      "r1_NumIdentcTit": "<string>",
      "r1_NumRefAtlCadTit": "<string>",
      "r1_NumSeqAtlzCadTit": "<string>",
      "r1_NumCtrlDDA": "<string>",
      "r1_DtHrDDA": "2023-11-07T05:31:56Z",
      "r1_DtMovto": "2023-11-07T05:31:56Z",
      "codOperacaoCli": "<string>",
      "dtSituacao": "2023-11-07T05:31:56Z",
      "msgSituacao": "<string>",
      "situacao": 0,
      "numControle": 123,
      "alteracaoBoletoDesctTit": [
        {
          "id": 123,
          "isValid": true,
          "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dtDesctTit": "2023-11-07T05:31:56Z",
          "codDesctTit": "<string>",
          "vlr_PercDesctTit": 123
        }
      ],
      "alteracaoBoletoJurosTit": {
        "id": 123,
        "isValid": true,
        "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dtJurosTit": "2023-11-07T05:31:56Z",
        "codJurosTit": "<string>",
        "vlr_PercJurosTit": 123
      },
      "alteracaoBoletoMultaTit": {
        "id": 123,
        "isValid": true,
        "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dtMultaTit": "2023-11-07T05:31:56Z",
        "codMultaTit": "<string>",
        "vlr_PercMultaTit": 123
      }
    }
  ]
}

Through this endpoint, partners can search for and view modifications made to a specific boleto. It is not possible to view changes made to payment titles.

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Query Parameters

codigoRegistroBoleto

string

Código UUID do 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.

codigoAlteracaoBoleto

string

Código UUID identificador da alteração de boleto.

alteracoes

object[] | null

Lista de alterações do boleto.

alteracoes.codigo

string

Código UUID identificador da alteração de boleto.

alteracoes.codigoConta

string

Código UUID identificador da conta.

alteracoes.codigoCedenteCarteira

string

Código UUID identificador do vínculo entre Cedente e Carteira.

alteracoes.origemRegistro

integer

1 = ApiInterna; 2 = ApiExterna; 3 = CNAB; 4 = ApiRetaguarda; 5 = ApiDbsNpc.

alteracoes.codMsg

string | null

Código da mensagem do sistema associado ao evento.

alteracoes.dtInclusao

string | null

Data de inclusão do registro de alteração.

alteracoes.codigoAcesso

string | null

Código UIID identificador do acesso.

alteracoes.codigoOperador

string | null

Código UUID identificador do operador que performou a ação.

alteracoes.numCtrlPart

string | null

Número de controle do participante.

alteracoes.ispbPartDestinatarioPrincipal

string | null

Número de Identificação do Participante no Sistema de Pagamentos Brasileiro, responsável pela emissão.

alteracoes.ispbPartDestinatarioAdmtd

string | null

Número de identificação do Participante no Sistema de Pagamentos Brasileiro, responsável por fornecer os dados ao Participante Principal.

alteracoes.numIdentcTit

string | null

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

alteracoes.numRefAtlCadTit

string | null

Número de referência do cadastro do Boleto de Pagamento.

alteracoes.indrManutBenfcrioOr

string | null

Indicador de manutenção do beneficiário original do boleto de pagamento. A = Alterar; M = Manter.

alteracoes.nomFantsBenfcrioOr

string | null

Nome fantasia do beneficiário original.

alteracoes.logradBenfcrioOr

string | null

Rua, número e complemento do beneficiário original.

alteracoes.cidBenfcrioOr

string | null

Cidade do beneficiário original

alteracoes.ufBenfcrioOr

string | null

Sigla da unidade da federação do beneficiário original.

alteracoes.cepBenfcrioOr

string | null

CEP do beneficiário original.

alteracoes.indrManutBenfcrioFinl

string | null

Indicador de manutenção do beneficiário final do boleto de pagamento. A = Alterar; E = Excluir; M = Manter.

alteracoes.tpPessoaBenfcrioFinl

string | null

Tipo de pessoa do beneficiário final. F = Pessoa Física; J = Pessoa Jurídica.

alteracoes.cnpJ_CPFBenfcrioFinl

string | null

CNPJ ou CPF do beneficiário final.

alteracoes.nom_RzSocBenfcrioFinl

string | null

Nome ou razão social do beneficiário final.

alteracoes.nomFantsBenfcrioFinl

string | null

Nome fantasia do beneficiário final.

alteracoes.indrManutPagdrTit

string | null

Indicador de manutenção do pagador do boleto de pagamento. A = Alterar; M = Manter.

alteracoes.nom_RzSocPagdr

string | null

Nome ou razão social do pagador.

alteracoes.nomFantsPagdr

string | null

Nome fantasia do pagador.

alteracoes.logradPagdr

string | null

Rua, número e complemento do pagador.

alteracoes.cidPagdr

string | null

Cidade do pagador.

alteracoes.ufPagdr

string | null

Sigla da unidade da federação do pagador.

alteracoes.cepPagdr

string | null

CEP do pagador.

alteracoes.indrManutSacdrAvalst

string | null

Indicador de manutenção do sacador avalista. A = Alterar; M = Manter.

alteracoes.tpIdentcSacdrAvalst

string | null

Tipo de identificação do sacador avalista. 0 = Isento / Não Informado; 1 = CPF; 2 = CNPJ.

alteracoes.identcSacdrAvalst

string | null

Identificação do sacador avalista.

alteracoes.nom_RzSocSacdrAvalst

string | null

Nome ou Razão Social do Sacador Avalista.

alteracoes.indrManutDocTit

string | null

Indicador de manutenção do documento do boleto de pagamento. A = Alterar; M = Manter.

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

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

alteracoes.numDocTit

string | null

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

alteracoes.tpPgtoTit

string | null

Tipo de Pagamento do Título. 1 = À Vista; 3 = Vencimento determinado; 4 = Carnê.

alteracoes.numParcl

integer | null

Número da parcela. Para Boleto de Pagamento do tipo carnê.

alteracoes.qtdTotParcl

integer | null

Quantidade total de parcelas. Para Boleto de Pagamento do tipo carnê.

alteracoes.indrTitNegcd

string | null

Indicador de Boleto de Pagamento Negociado. N = Não; S = Sim.

alteracoes.indrManutInstcPgtoTit

string | null

Indicador de manutenção da instrução de pagamento do Boleto de Pagamento. A = Alterar; M = Manter.

alteracoes.dtVencTit

string | null

Data de Vencimento do Título. Esta data deverá estar dentro do período de antecedência ou atraso estabelecido.

alteracoes.vlrTit

number | null

Valor nominal do boleto de pagamento, não considerando abatimento ou dedução.

alteracoes.qtdDiaPrott

integer | null

Quantidade de dias corridos para protesto.

alteracoes.dtLimPgtoTit

string | null

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

alteracoes.indrBloqPgto

string | null

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

alteracoes.vlrAbattTit

number | null

Valor total dos abatimentos para o boleto de pagamento.

alteracoes.qtdPgtoParcl

integer | null

Quantidade de pagamentos parciais.

alteracoes.tpModlCalc

string | null

Tipo de modelo de cálculo. 01 = Instituição recebedora calcula títulos a vencer e vencidos; 02 = Instituição destinatária calcula títulos vencidos e recebedora calcula títulos a vencer; 03 = Instituição destinatária calcula títulos a vencer e vencidos; 04 = CIP / Instituição Recebedora calcula saldo para pagamento parcial e títulos a vencer e vencidos em resposta a uma solicitação de consulta;

alteracoes.indrManutInstcVlrRecbt

string | null

Indicador de manutenção da instrução de valor do recebimento. A = Alterar; M = Manter.

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

alteracoes.tpVlr_PercMinTit

string | null

Identifica se Vlr_PercMinTit representa um valor ou um percentual mínimo do boleto de pagamento. P = Percentual; V = Valor.

alteracoes.vlr_PercMinTit

number | null

Valor ou percentual mínimo do boleto de pagamento.

alteracoes.tpVlr_PercMaxTit

string | null

Identifica se representa um valor ou um percentual máximo do boleto de pagamento. P = Percentual; V = Valor.

alteracoes.vlr_PercMaxTit

number | null

Valor ou percentual máximo do boleto de pagamento.

alteracoes.indrManutJurosTit

string | null

Indicador de manutenção de juros do boleto de pagamento. A = Alterar; M = Manter.

alteracoes.indrManutMultaTit

string | null

Indicador de manutenção da multa do boleto de pagamento. A = Alterar; M = Manter.

alteracoes.indrManutDesctTit

string | null

Indicador de manutenção do desconto do boleto de pagamento. A = Alterar; M = Manter.

alteracoes.indrManutHistNotaFis

string | null

Indicador de manutenção do histórico da nota fiscal. A = Alterar; E = Excluir; M = Manter.

alteracoes.indrManutHistTxtInf

string | null

Indicador de manutenção do histórico do texto informativo. A = Alterar; E = Excluir; M = Manter.

alteracoes.txtInfBenfcrio

string | null

Texto Informação Beneficiário. Este campo será utilizado para envio de informações do beneficiário para o cliente pagador.

alteracoes.dtMovto

string | null

Data de movimento.

alteracoes.r1_NumIdentcTit

string | null

Número único de identificação do boleto de pagamento.

alteracoes.r1_NumRefAtlCadTit

string | null

Número de referência do cadastro do Boleto de Pagamento.

alteracoes.r1_NumSeqAtlzCadTit

string | null

Número de sequência da atualização do cadastro do boleto de pagamento.

alteracoes.r1_NumCtrlDDA

string | null

Número de controle do DDA.

alteracoes.r1_DtHrDDA

string | null

Data Hora do DDA.

alteracoes.r1_DtMovto

string | null

Data de movimento.

alteracoes.codOperacaoCli

string | null

alteracoes.dtSituacao

string | null

Data da situação atual.

alteracoes.msgSituacao

string | null

Situação no formato de texto.

alteracoes.situacao

enum<integer>

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

50,

97,

98,

99

alteracoes.numControle

integer | null

alteracoes.alteracaoBoletoDesctTit

object[] | null

Lista de informações relativas à desconto da alteração de Boleto.

alteracoes.alteracaoBoletoJurosTit

object

Informações relativas à juros da alteração de Boleto.

alteracoes.alteracaoBoletoMultaTit

object

Informações relativas à multa da alteração de Boleto.

Was this page helpful?

54 - Update Bankslip 56 - Check Last Boleto Modification

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alteracoes": [
    {
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoCedenteCarteira": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "origemRegistro": 123,
      "codMsg": "<string>",
      "dtInclusao": "2023-11-07T05:31:56Z",
      "codigoAcesso": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoOperador": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "numCtrlPart": "<string>",
      "ispbPartDestinatarioPrincipal": "<string>",
      "ispbPartDestinatarioAdmtd": "<string>",
      "numIdentcTit": "<string>",
      "numRefAtlCadTit": "<string>",
      "indrManutBenfcrioOr": "<string>",
      "nomFantsBenfcrioOr": "<string>",
      "logradBenfcrioOr": "<string>",
      "cidBenfcrioOr": "<string>",
      "ufBenfcrioOr": "<string>",
      "cepBenfcrioOr": "<string>",
      "indrManutBenfcrioFinl": "<string>",
      "tpPessoaBenfcrioFinl": "<string>",
      "cnpJ_CPFBenfcrioFinl": "<string>",
      "nom_RzSocBenfcrioFinl": "<string>",
      "nomFantsBenfcrioFinl": "<string>",
      "indrManutPagdrTit": "<string>",
      "nom_RzSocPagdr": "<string>",
      "nomFantsPagdr": "<string>",
      "logradPagdr": "<string>",
      "cidPagdr": "<string>",
      "ufPagdr": "<string>",
      "cepPagdr": "<string>",
      "indrManutSacdrAvalst": "<string>",
      "tpIdentcSacdrAvalst": "<string>",
      "identcSacdrAvalst": "<string>",
      "nom_RzSocSacdrAvalst": "<string>",
      "indrManutDocTit": "<string>",
      "codCartTit": "<string>",
      "codEspTit": "<string>",
      "numDocTit": "<string>",
      "tpPgtoTit": "<string>",
      "numParcl": 123,
      "qtdTotParcl": 123,
      "indrTitNegcd": "<string>",
      "indrManutInstcPgtoTit": "<string>",
      "dtVencTit": "2023-11-07T05:31:56Z",
      "vlrTit": 123,
      "qtdDiaPrott": 123,
      "dtLimPgtoTit": "2023-11-07T05:31:56Z",
      "indrBloqPgto": "<string>",
      "vlrAbattTit": 123,
      "qtdPgtoParcl": 123,
      "tpModlCalc": "<string>",
      "indrManutInstcVlrRecbt": "<string>",
      "tpAutcRecbtVlrDivgte": "<string>",
      "tpVlr_PercMinTit": "<string>",
      "vlr_PercMinTit": 123,
      "tpVlr_PercMaxTit": "<string>",
      "vlr_PercMaxTit": 123,
      "indrManutJurosTit": "<string>",
      "indrManutMultaTit": "<string>",
      "indrManutDesctTit": "<string>",
      "indrManutHistNotaFis": "<string>",
      "indrManutHistTxtInf": "<string>",
      "txtInfBenfcrio": "<string>",
      "dtMovto": "2023-11-07T05:31:56Z",
      "r1_NumIdentcTit": "<string>",
      "r1_NumRefAtlCadTit": "<string>",
      "r1_NumSeqAtlzCadTit": "<string>",
      "r1_NumCtrlDDA": "<string>",
      "r1_DtHrDDA": "2023-11-07T05:31:56Z",
      "r1_DtMovto": "2023-11-07T05:31:56Z",
      "codOperacaoCli": "<string>",
      "dtSituacao": "2023-11-07T05:31:56Z",
      "msgSituacao": "<string>",
      "situacao": 0,
      "numControle": 123,
      "alteracaoBoletoDesctTit": [
        {
          "id": 123,
          "isValid": true,
          "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dtDesctTit": "2023-11-07T05:31:56Z",
          "codDesctTit": "<string>",
          "vlr_PercDesctTit": 123
        }
      ],
      "alteracaoBoletoJurosTit": {
        "id": 123,
        "isValid": true,
        "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dtJurosTit": "2023-11-07T05:31:56Z",
        "codJurosTit": "<string>",
        "vlr_PercJurosTit": 123
      },
      "alteracaoBoletoMultaTit": {
        "id": 123,
        "isValid": true,
        "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoAlteracaoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dtMultaTit": "2023-11-07T05:31:56Z",
        "codMultaTit": "<string>",
        "vlr_PercMultaTit": 123
      }
    }
  ]
}

Initial Guide

Developer's Guide

APIs Reference

55 - Check Modifications

Authorizations

Query Parameters

Response