curl --request GET \
  --url https://api.bmpdigital.moneyp.dev.br/api/Boleto/BoletosRegistrados \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "dtConsulta": "2023-11-07T05:31:56Z",
  "documentoFederal": "<string>",
  "conta": {
    "banco": "<string>",
    "agencia": "<string>",
    "contaPgto": "<string>"
  },
  "filtro": {
    "carteiraInicial": 123,
    "carteiraFinal": 123,
    "dtRegistroInicial": "2023-11-07T05:31:56Z",
    "dtRegistroFinal": "2023-11-07T05:31:56Z",
    "dtVenctoInicial": "2023-11-07T05:31:56Z",
    "dtVenctoFinal": "2023-11-07T05:31:56Z",
    "situacaoBoleto": 1,
    "page": 123,
    "pageSize": 123
  },
  "cedentes": [
    {
      "cedente": 123,
      "carteira": 123,
      "boletosRegistrados": [
        {
          "dataRegistro": "<string>",
          "tipoRegistro": 1,
          "descTipoRegistro": "<string>",
          "codigoBarras": "<string>",
          "situacao": 1,
          "descSituacao": "<string>",
          "vlrBoleto": 123,
          "vlrPago": 123,
          "dtVencimento": "<string>",
          "dtCredito": "<string>",
          "dtPagamento": "<string>",
          "cnpJ_CPFPagdr": "<string>",
          "nom_RzSocPagdr": "<string>",
          "identdNossoNum": "<string>",
          "numeroDocumento": "<string>",
          "indSacadorAvalista": 0,
          "identificadorSacadorAvalista": "<string>",
          "nomeRazaoSocialSacadorAvalista": "<string>"
        }
      ]
    }
  ]
}

Through this endpoint, partners can list the boletos registered with BMP-274. This process is exclusive to the integrator.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
DocumentoFederal
string
​
Conta.Banco
string

Número do Banco.

​
Conta.Agencia
string

Número da Agência Bancária.

​
Conta.ContaPgto
string

Número da Conta Bancária seguido do dígito verificador.

​
Filtro.CarteiraInicial
integer

Número da carteira inicial da busca.

​
Filtro.CarteiraFinal
integer

Número da carteira final da busca.

​
Filtro.DtRegistroInicial
string

Data de registro inicial da busca.

​
Filtro.DtRegistroFinal
string

Data de registro final da busca.

​
Filtro.DtVenctoInicial
string

Data de vencimento inicial da busca.

​
Filtro.DtVenctoFinal
string

Data de vencimento final da busca.

​
Filtro.SituacaoBoleto
enum<integer>
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
​
Filtro.Page
integer

Número da página.

​
Filtro.PageSize
integer

Tamanho da página. Itens por página.

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.

​
dtConsulta
string | null

Data da consulta.

​
documentoFederal
string | null

Documento Federal do cedente.

​
conta
object

Dados relativos à conta do cedente.

​
filtro
object

Dados relativos aos filtros usados na busca.

​
cedentes
object[] | null

Lista de Cedentes vinculados ao Documento Federal.

Was this page helpful?