curl --request GET \
  --url https://api.ext.dbs.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
Conta.Agencia
string
Conta.ContaPgto
string
Filtro.CarteiraInicial
integer
Filtro.CarteiraFinal
integer
Filtro.DtRegistroInicial
string
Filtro.DtRegistroFinal
string
Filtro.DtVenctoInicial
string
Filtro.DtVenctoFinal
string
Filtro.SituacaoBoleto
enum<integer>
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
Filtro.Page
integer
Filtro.PageSize
integer

Response

200 - application/json

Success

The response is of type object.