Pular para o conteúdo principal
GET
/
api
/
Boleto
/
BoletosRegistrados
Consulta todos os boletos bancários registrados de uma conta específica.
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>"
        }
      ]
    }
  ]
}
Por meio desse endpoint, o parceiro pode listar os boletos registrados junto a BMP-274, esse processo é exclusivo ao integrador.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
DocumentoFederal
string

Número do CPF ou CNPJ do correntista.

Observação:

  • Quando o 'número da conta bancária seguido do dígito verificador' (contaPgto) estiver preenchido, o 'número do CPF ou CNPJ do correntista' (documentoFederal) não deve ser informado.
​
Conta.Banco
string

Número do banco.

Observação:

  • São aceitos somentes os bancos números 274 ou 531.
​
Conta.Agencia
string

Número da agência bancária.

​
Conta.ContaPgto
string

Número da conta bancária seguido do dígito verificador.

Observação:

  • Quando o 'número do CPF ou CNPJ do correntista' (documentoFederal) estiver preenchido, o 'número da conta bancária seguido do dígito verificador' (contaPgto) não deve ser informado.
​
Filtro.CarteiraInicial
integer<int32>

Número da carteira inicial da busca.

Observação:

  • O 'número da carteira inicial' (carteiraInicial) não pode ser maior que o 'número da carteira final' (carteiraFinal), quando este for informado.
​
Filtro.CarteiraFinal
integer<int32>

Número da carteira final da busca.

Observação:

  • O 'número da carteira final' (carteiraFinal) não pode ser menor que o 'número da carteira inicial' (carteiraInicial), quando este for informado.
​
Filtro.DtRegistroInicial
string<date-time>

Data de registro inicial da busca.

Observação:

  • A 'data de registro inicial' (dtRegistroInicial) não pode ser posterior à 'data de registro final' (dtRegistroFinal), quando esta for informada.
​
Filtro.DtRegistroFinal
string<date-time>

Data de registro final da busca.

Observações:

  • A 'data de registro final' (dtRegistroFinal) não pode ser anterior à 'data de registro inicial' (dtRegistroInicial), quando esta for informada.
  • O intervalo de dias entre a 'data de registro inicial' (dtRegistroInicial) e a 'data de registro final' (dtRegistroFinal) não pode ser superior a 31 dias.
​
Filtro.DtVenctoInicial
string<date-time>

Data de vencimento inicial da busca.

Observação:

  • A 'data de vencimento inicial' (dtVenctoInicial) não pode ser posterior à 'data de vencimento final' (dtVenctoFinal), quando esta for informada.
​
Filtro.DtVenctoFinal
string<date-time>

Data de vencimento final da busca.

Observações:

  • A 'data de vencimento final' (dtVenctoFinal) não pode ser anterior à 'data de vencimento inicial' (dtVenctoInicial), quando esta for informada.
  • O intervalo de dias entre a 'data de vencimento inicial' (dtVenctoInicial) e a 'data de vencimento final' (dtVenctoFinal) não pode ser superior a 31 dias.
​
Filtro.SituacaoBoleto
enum<integer>

Situacao do boleto.*

Valores: 1 - Pendente Registro 2 - Registrado 3 - Erro Registro 4 - Pago 5 - Baixado Cedente 6 - Baixado Data Limite Pagto 7 - Pendente Baixa Cedente 8 - Pendente Baixa Protesto 9 - Protestado 10 - Pago Em Cartório

Opções disponíveis:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
​
Filtro.Page
integer<int32>

Número da página.

​
Filtro.PageSize
integer<int32>

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

Response

Success

​
sucesso
boolean
​
mensagem
string | null
​
dtConsulta
string<date-time> | null
​
documentoFederal
string | null
​
conta
object
​
filtro
object
​
cedentes
object[] | null