Scopes:
api.ext api.boleto.boletosRegistrados Through this endpoint, the partner can list the bills registered with BMP-274, this process is exclusive to the integrator. ## OpenAPI ````yaml get /api/Boleto/BoletosRegistrados openapi: 3.0.1 info: title: BMPSPBExt description: 'Build Number: #0.0
' version: v1 servers: - url: https://api.ext.dbs.moneyp.dev.br/ description: Localhost security: - Bearer: [] paths: /api/Boleto/BoletosRegistrados: get: tags: - Boleto summary: Consulta todos os boletos bancários registrados de uma conta específica. description: "Scopes:
\r\napi.ext api.boleto.boletosRegistrados" parameters: - name: DocumentoFederal in: query description: >- 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. schema: type: string description: >- 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. - name: Conta.Banco in: query description: |- Número do banco. Observação: - São aceitos somentes os bancos números 274 ou 531. schema: type: string description: |- Número do banco. Observação: - São aceitos somentes os bancos números 274 ou 531. - name: Conta.Agencia in: query description: Número da agência bancária. schema: type: string description: Número da agência bancária. - name: Conta.ContaPgto in: query description: >- 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. schema: type: string description: >- 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. - name: Filtro.CarteiraInicial in: query description: >- 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. schema: type: integer description: >- 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. format: int32 - name: Filtro.CarteiraFinal in: query description: >- 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. schema: type: integer description: >- 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. format: int32 - name: Filtro.DtRegistroInicial in: query description: >- 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. schema: type: string description: >- 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. format: date-time - name: Filtro.DtRegistroFinal in: query description: >- 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. schema: type: string description: >- 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. format: date-time - name: Filtro.DtVenctoInicial in: query description: >- 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. schema: type: string description: >- 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. format: date-time - name: Filtro.DtVenctoFinal in: query description: >- 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. schema: type: string description: >- 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. format: date-time - name: Filtro.SituacaoBoleto in: query description: |- 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 schema: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoBoleto' description: |- 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 - name: Filtro.Page in: query description: Número da página. schema: type: integer description: Número da página. format: int32 - name: Filtro.PageSize in: query description: Tamanho da página. Itens por página. schema: type: integer description: Tamanho da página. Itens por página. format: int32 responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosResponse '400': description: Erro de negócio content: application/json: schema: type: object properties: sucesso: type: boolean mensagem: type: string '500': description: Erro interno do servidor content: application/json: schema: type: object properties: sucesso: type: boolean mensagem: type: string components: schemas: BMPSPB.Infra.Enums.SituacaoBoleto: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: integer description: '' format: int32 BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosResponse: type: object properties: sucesso: type: boolean mensagem: type: string nullable: true dtConsulta: type: string format: date-time nullable: true readOnly: true documentoFederal: type: string nullable: true conta: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosConta nullable: true filtro: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosFiltro nullable: true cedentes: type: array items: $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosCedentes nullable: true additionalProperties: false BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosConta: type: object properties: banco: type: string description: |- Número do banco. Observação: - São aceitos somentes os bancos números 274 ou 531. nullable: true agencia: type: string description: Número da agência bancária. nullable: true contaPgto: type: string description: >- 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. nullable: true additionalProperties: false BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosFiltro: type: object properties: carteiraInicial: type: integer description: >- 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. format: int32 nullable: true carteiraFinal: type: integer description: >- 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. format: int32 nullable: true dtRegistroInicial: type: string description: >- 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. format: date-time nullable: true dtRegistroFinal: type: string description: >- 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. format: date-time nullable: true dtVenctoInicial: type: string description: >- 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. format: date-time nullable: true dtVenctoFinal: type: string description: >- 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. format: date-time nullable: true situacaoBoleto: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoBoleto' description: |- 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 nullable: true page: type: integer description: Número da página. format: int32 pageSize: type: integer description: Tamanho da página. Itens por página. format: int32 additionalProperties: false BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosCedentes: type: object properties: cedente: type: integer format: int64 nullable: true carteira: type: integer format: int32 nullable: true boletosRegistrados: type: array items: $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosBoleto nullable: true additionalProperties: false BMPSPB.Domain.Messaging.API.Externa.DDA.BoletosRegistradosBoleto: type: object properties: dataRegistro: type: string nullable: true tipoRegistro: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoRegistro' nullable: true descTipoRegistro: type: string nullable: true readOnly: true codigoBarras: type: string nullable: true situacao: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoBoleto' nullable: true descSituacao: type: string nullable: true readOnly: true vlrBoleto: type: number format: double nullable: true vlrPago: type: number format: double nullable: true dtVencimento: type: string nullable: true dtCredito: type: string nullable: true dtPagamento: type: string nullable: true cnpJ_CPFPagdr: type: string nullable: true nom_RzSocPagdr: type: string nullable: true identdNossoNum: type: string nullable: true numeroDocumento: type: string nullable: true indSacadorAvalista: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoSacadorAvalista' nullable: true identificadorSacadorAvalista: type: string nullable: true nomeRazaoSocialSacadorAvalista: type: string nullable: true additionalProperties: false BMPSPB.Infra.Enums.TipoRegistro: enum: - 1 - 2 - 3 type: integer description: '' format: int32 BMPSPB.Infra.Enums.TipoSacadorAvalista: enum: - 0 - 1 - 2 - 3 - 9 type: integer description: '' format: int32 securitySchemes: Bearer: type: apiKey description: Copie 'Bearer ' + token name: Authorization in: header ````