57 - Other Banks' Bankslips

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoRetorno": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dadosTitulo": {
    "numLinhaDigtvl": "<string>",
    "numCodBarras": "<string>",
    "nomFantsBenfcrioOr": "<string>",
    "dtVencTit": "2023-11-07T05:31:56Z",
    "cnpjCpfBenfcrioOr": "<string>",
    "vlrTit": 123,
    "tpPessoaBenfcrioOr": "<string>",
    "codPartDestinatario": "<string>",
    "numIdentcTit": "<string>",
    "numRefAtlCadTit": "<string>",
    "indrPgtoParcl": "<string>",
    "tpAutcRecbtVlrDivgte": "<string>",
    "codEspTit": 123,
    "numCtrlPart": "<string>",
    "ispbPartRecbdrPrincipal": "<string>",
    "ispbPartRecbdrAdmtd": "<string>",
    "numCtrlDDA": "<string>",
    "numSeqAtlzCadTit": "<string>",
    "dtHrSitTit": "2023-11-07T05:31:56Z",
    "ispbPartDestinatario": "<string>",
    "nomRzSocBenfcrioOr": "<string>",
    "tpPessoaPagdr": "<string>",
    "cnpjCpfPagdr": "<string>",
    "nomRzSocPagdr": "<string>",
    "codMoedaCNAB": "<string>",
    "dtLimPgtoTit": "2023-11-07T05:31:56Z",
    "indrBloqPgto": "<string>",
    "vlrAbattTit": 123,
    "tpModlCalc": "<string>",
    "sitTitPgto": "<string>",
    "dtHrDDA": "2023-11-07T05:31:56Z",
    "dtMovto": "2023-11-07T05:31:56Z",
    "tpVlr_PercMinTit": "<string>",
    "vlr_PercMinTit": 123,
    "tpVlr_PercMaxTit": "<string>",
    "vlr_PercMaxTit": 123,
    "totalBaixasParciais": 123,
    "tpIdentcSacdrAvalst": "<string>",
    "identcSacdrAvalst": "<string>",
    "nom_RzSocSacdrAvalst": "<string>",
    "emissor": "<string>",
    "result": 123,
    "tipo": 1
  },
  "juros": {
    "codJurosTit": "<string>",
    "dtJurosTit": "2023-11-07T05:31:56Z",
    "vlrPercJurosTit": 123,
    "total": 123
  },
  "multa": {
    "codMultaTit": "<string>",
    "dtMultaTit": "2023-11-07T05:31:56Z",
    "vlrPercMultaTit": 123,
    "total": 123
  },
  "descontos": [
    {
      "codDesctTit": "<string>",
      "dtDesctTit": "2023-11-07T05:31:56Z",
      "vlrPercDesctTit": 123,
      "total": 123
    }
  ],
  "validacoes": [
    {
      "mensagem": "<string>"
    }
  ],
  "sucessoRetornoCM": true,
  "origemConsulta": 1,
  "vlrTitTotal": 123
}

Through this endpoint, partners can query bankslips that are registered with another financial institution.

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Query Parameters

LinhaDigitavel

string

Sequência numérica digitável presente no boleto bancário.

CodigoBarras

string

Sequência numérica que corresponde ao código de barras impresso no boleto bancário.

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.

codigoRetorno

string

Código UUID identificador do boleto consultado. Diferente do código de registro do boleto.

dadosTitulo

object

Dados referentes ao boleto.

dadosTitulo.numLinhaDigtvl

string | null

Linha digitável do Boleto de Pagamento.

dadosTitulo.numCodBarras

string | null

Código de barras do Boleto de Pagamento.

dadosTitulo.nomFantsBenfcrioOr

string | null

Nome fantasia do beneficiário.

dadosTitulo.dtVencTit

string | null

Data de vencimento do título.

dadosTitulo.cnpjCpfBenfcrioOr

string | null

CNPJ ou CPF do beneficiário original.

dadosTitulo.vlrTit

number

Valor do Título.

dadosTitulo.tpPessoaBenfcrioOr

string | null

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

dadosTitulo.codPartDestinatario

string | null

Código do participante destinatário utilizado na compensação.

dadosTitulo.numIdentcTit

string | null

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

dadosTitulo.numRefAtlCadTit

string | null

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

dadosTitulo.indrPgtoParcl

string | null

Identifica se o Boleto de Pagamento permite pagamento parcial. N = Não; S = Sim.

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

dadosTitulo.codEspTit

integer

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

dadosTitulo.numCtrlPart

string | null

Número de controle do participante

dadosTitulo.ispbPartRecbdrPrincipal

string | null

Número de identificação do participante recebedor principal no Sistema de Pagamentos Brasileiro.

dadosTitulo.ispbPartRecbdrAdmtd

string | null

Número de identificação do participante recebedor administrado no Sistema de Pagamentos Brasileiro.

dadosTitulo.numCtrlDDA

string | null

Número de controle do DDA.

dadosTitulo.numSeqAtlzCadTit

string | null

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

dadosTitulo.dtHrSitTit

string

Data e hora da situação do boleto de pagamento.

dadosTitulo.ispbPartDestinatario

string | null

Número de identificação do participante destinatário no Sistema de Pagamentos Brasileiro.

dadosTitulo.nomRzSocBenfcrioOr

string | null

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

dadosTitulo.tpPessoaPagdr

string | null

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

dadosTitulo.cnpjCpfPagdr

string | null

CNPJ ou CPF do pagador.

dadosTitulo.nomRzSocPagdr

string | null

Nome ou razão social do pagador.

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

dadosTitulo.dtLimPgtoTit

string | null

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

dadosTitulo.indrBloqPgto

string | null

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

dadosTitulo.vlrAbattTit

number

Valor total dos abatimentos para o boleto de pagamento.

dadosTitulo.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;

dadosTitulo.sitTitPgto

string | null

Situação do boleto de pagamento para pagamento.

dadosTitulo.dtHrDDA

string

Data Hora do DDA.

dadosTitulo.dtMovto

string

Data de movimento.

dadosTitulo.tpVlr_PercMinTit

string | null

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

dadosTitulo.vlr_PercMinTit

number | null

Valor ou percentual mínimo do boleto de pagamento.

dadosTitulo.tpVlr_PercMaxTit

string | null

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

dadosTitulo.vlr_PercMaxTit

number | null

Valor ou percentual máximo do boleto de pagamento

dadosTitulo.totalBaixasParciais

number | null

dadosTitulo.tpIdentcSacdrAvalst

string | null

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

dadosTitulo.identcSacdrAvalst

string | null

Identificação do sacador avalista

dadosTitulo.nom_RzSocSacdrAvalst

string | null

Nome ou Razão Social do Sacador Avalista

dadosTitulo.emissor

string | null

Identificação do emissor do boleto, responsável pela geração e emissão do documento.

dadosTitulo.result

integer

dadosTitulo.tipo

enum<integer>

Available options:

1,

2

juros

object

Dados referentes à juros.

multa

object

Dados referentes à multa.

descontos

object[] | null

Lista de dados referentes à descontos.

validacoes

object[] | null

Lista de validações.

sucessoRetornoCM

boolean

Indicativo de sucesso na comunicação com a CM.

origemConsulta

enum<integer>

Available options:

1,

2

vlrTitTotal

number

Valor calculado total a ser pago.

Was this page helpful?

56 - Check Last Boleto Modification 58 - Check Payer

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoRetorno": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dadosTitulo": {
    "numLinhaDigtvl": "<string>",
    "numCodBarras": "<string>",
    "nomFantsBenfcrioOr": "<string>",
    "dtVencTit": "2023-11-07T05:31:56Z",
    "cnpjCpfBenfcrioOr": "<string>",
    "vlrTit": 123,
    "tpPessoaBenfcrioOr": "<string>",
    "codPartDestinatario": "<string>",
    "numIdentcTit": "<string>",
    "numRefAtlCadTit": "<string>",
    "indrPgtoParcl": "<string>",
    "tpAutcRecbtVlrDivgte": "<string>",
    "codEspTit": 123,
    "numCtrlPart": "<string>",
    "ispbPartRecbdrPrincipal": "<string>",
    "ispbPartRecbdrAdmtd": "<string>",
    "numCtrlDDA": "<string>",
    "numSeqAtlzCadTit": "<string>",
    "dtHrSitTit": "2023-11-07T05:31:56Z",
    "ispbPartDestinatario": "<string>",
    "nomRzSocBenfcrioOr": "<string>",
    "tpPessoaPagdr": "<string>",
    "cnpjCpfPagdr": "<string>",
    "nomRzSocPagdr": "<string>",
    "codMoedaCNAB": "<string>",
    "dtLimPgtoTit": "2023-11-07T05:31:56Z",
    "indrBloqPgto": "<string>",
    "vlrAbattTit": 123,
    "tpModlCalc": "<string>",
    "sitTitPgto": "<string>",
    "dtHrDDA": "2023-11-07T05:31:56Z",
    "dtMovto": "2023-11-07T05:31:56Z",
    "tpVlr_PercMinTit": "<string>",
    "vlr_PercMinTit": 123,
    "tpVlr_PercMaxTit": "<string>",
    "vlr_PercMaxTit": 123,
    "totalBaixasParciais": 123,
    "tpIdentcSacdrAvalst": "<string>",
    "identcSacdrAvalst": "<string>",
    "nom_RzSocSacdrAvalst": "<string>",
    "emissor": "<string>",
    "result": 123,
    "tipo": 1
  },
  "juros": {
    "codJurosTit": "<string>",
    "dtJurosTit": "2023-11-07T05:31:56Z",
    "vlrPercJurosTit": 123,
    "total": 123
  },
  "multa": {
    "codMultaTit": "<string>",
    "dtMultaTit": "2023-11-07T05:31:56Z",
    "vlrPercMultaTit": 123,
    "total": 123
  },
  "descontos": [
    {
      "codDesctTit": "<string>",
      "dtDesctTit": "2023-11-07T05:31:56Z",
      "vlrPercDesctTit": 123,
      "total": 123
    }
  ],
  "validacoes": [
    {
      "mensagem": "<string>"
    }
  ],
  "sucessoRetornoCM": true,
  "origemConsulta": 1,
  "vlrTitTotal": 123
}

Initial Guide

Developer's Guide

APIs Reference

57 - Other Banks' Bankslips

Authorizations

Query Parameters

Response