> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 38 - Consult Extract

> <p>Scopes:</p>
<b>api.ext api.conta.extrato</b>

Through this endpoint, the partner can request a bank statement of the account's transactions, thus viewing the history of debit and credit transactions that occurred during the requested period.


## OpenAPI

````yaml get /api/Conta/Extrato
openapi: 3.0.1
info:
  title: BMPSPBExt
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.dbs.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/Conta/Extrato:
    get:
      tags:
        - Conta
      description: "<p>Scopes:</p>\r\n<b>api.ext api.conta.extrato</b>"
      parameters:
        - name: DiaInicial
          in: query
          schema:
            type: integer
            format: int32
        - name: DiaFinal
          in: query
          schema:
            type: integer
            format: int32
        - name: Mes
          in: query
          schema:
            type: integer
            format: int32
        - name: Ano
          in: query
          schema:
            type: integer
            format: int32
        - name: NumeroBanco
          in: query
          schema:
            type: integer
            format: int32
        - name: Conta.Agencia
          in: query
          description: |-
            Número da agência bancária.*

            Observações:
            - O número da agência pode ter no máximo 4 caracteres.
          schema:
            type: string
            description: |-
              Número da agência bancária.*

              Observações:
              - O número da agência pode ter no máximo 4 caracteres.
        - name: Conta.AgenciaDigito
          in: query
          description: >-
            Dígito verificador da agência bancária.


            Observações:

            - O dígito verificador da agência bancária pode ter no máximo 1
            caracter.
          schema:
            type: string
            description: >-
              Dígito verificador da agência bancária.


              Observações:

              - O dígito verificador da agência bancária pode ter no máximo 1
              caracter.
        - name: Conta.Conta
          in: query
          description: >-
            Número da conta bancária.


            Observações:

            - O número da conta bancária pode ter no máximo 12 caracteres.

            - Para que seja possível localizar a conta, é necessário informar o
            'número da conta com dígito' (```contaPgto```) ou o 'número da
            conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

            - Caso o 'número da conta com dígito' (```contaPgto```) seja
            informado, não é necessário preencher os campos 'número da conta'
            (```conta```) e 'dígito verificador' (```contaDigito```).

            - Caso nenhum dos campos referentes ao número da conta seja
            informado, ocorrerá erro na requisição devido à falta de informação
            vital.
          schema:
            type: string
            description: >-
              Número da conta bancária.


              Observações:

              - O número da conta bancária pode ter no máximo 12 caracteres.

              - Para que seja possível localizar a conta, é necessário informar
              o 'número da conta com dígito' (```contaPgto```) ou o 'número da
              conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

              - Caso o 'número da conta com dígito' (```contaPgto```) seja
              informado, não é necessário preencher os campos 'número da conta'
              (```conta```) e 'dígito verificador' (```contaDigito```).

              - Caso nenhum dos campos referentes ao número da conta seja
              informado, ocorrerá erro na requisição devido à falta de
              informação vital.
        - name: Conta.ContaDigito
          in: query
          description: >-
            Dígito verificador do número da conta bancária.


            Observações:

            - O dígito verificador do número da conta bancária pode ter no
            máximo 1 caracter.
          schema:
            type: string
            description: >-
              Dígito verificador do número da conta bancária.


              Observações:

              - O dígito verificador do número da conta bancária pode ter no
              máximo 1 caracter.
        - name: Conta.ContaPgto
          in: query
          description: >-
            Número da conta bancária seguido do dígito verificador.


            Observações:

            - O número da conta seguido do dígito verificador pode ter no máximo
            20 caracteres.
          schema:
            type: string
            description: >-
              Número da conta bancária seguido do dígito verificador.


              Observações:

              - O número da conta seguido do dígito verificador pode ter no
              máximo 20 caracteres.
        - name: Conta.TipoConta
          in: query
          description: |-
            Tipo da conta.*

            Valores:
            1 - Corrente
            2 - Poupanca
            3 - Pagamento
            4 - Salario
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta'
            description: |-
              Tipo da conta.*

              Valores:
              1 - Corrente
              2 - Poupanca
              3 - Pagamento
              4 - Salario
        - name: Conta.ModeloConta
          in: query
          description: |-
            Modelo da conta.*

            Valores:
            1 - Movimento
            2 - Escrow
            3 - Vinculada
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.ModeloConta'
            description: |-
              Modelo da conta.*

              Valores:
              1 - Movimento
              2 - Escrow
              3 - Vinculada
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.Conta.ConsultaExtratoResponse
        '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.TipoConta:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.ModeloConta:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
    BMPSPB.Domain.Messaging.API.Externa.Conta.ConsultaExtratoResponse:
      type: object
      properties:
        sucesso:
          type: boolean
        mensagem:
          type: string
          nullable: true
        dtExtrato:
          type: string
          format: date-time
        movimentos:
          type: array
          items:
            $ref: >-
              #/components/schemas/BMPSPB.Domain.Messaging.API.Shared.Conta.Extrato
          nullable: true
      additionalProperties: false
    BMPSPB.Domain.Messaging.API.Shared.Conta.Extrato:
      type: object
      properties:
        codigo:
          type: string
          format: uuid
        codigoTransacao:
          type: string
          format: uuid
        dtMovimento:
          type: string
          format: date-time
          nullable: true
        dtMovimentoUtc:
          type: string
          format: date-time
          nullable: true
        descricaoOperacao:
          type: string
          nullable: true
        tipoLancamento:
          type: string
          nullable: true
        vlrMovimento:
          type: number
          format: double
        nsu:
          type: integer
          format: int64
          nullable: true
        codOperacaoCli:
          type: string
          nullable: true
        descCliente:
          type: string
          nullable: true
        documentoFederal:
          type: string
          nullable: true
        nome:
          type: string
          nullable: true
        operador:
          type: string
          nullable: true
        origemTransacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.OrigemTransacao'
        bancoOrigem:
          type: string
          nullable: true
        agenciaOrigem:
          type: string
          nullable: true
        contaOrigem:
          type: string
          nullable: true
        identificadorOperacao:
          type: string
          nullable: true
        saldoFinalDia:
          type: number
          format: double
        origemMovimento:
          type: string
          nullable: true
        complemento:
          type: string
          nullable: true
          readOnly: true
        pixQrCode:
          type: boolean
        nomeDestinatario:
          type: string
          nullable: true
        documentoDestinatario:
          type: string
          nullable: true
        dadosBancarioDestinatario:
          type: string
          nullable: true
        numeroControle:
          type: string
          nullable: true
        descricao:
          type: string
          nullable: true
        pixChave:
          type: string
          nullable: true
        codigoBarras:
          type: string
          nullable: true
        dadosBancariosOrigem:
          type: string
          nullable: true
        nomeOrigem:
          type: string
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.OrigemTransacao:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 1001
        - 1002
        - 1003
        - 1004
        - 1005
        - 1006
        - 1007
        - 1008
        - 1009
        - 1010
        - 1011
        - 1012
        - 1013
        - 1014
        - 1200
        - 1501
        - 1502
        - 1503
        - 1601
        - 1701
        - 2001
        - 2002
        - 2003
        - 2004
        - 2010
        - 2012
        - 2501
        - 3001
        - 3002
        - 4001
        - 4501
        - 5001
        - 5002
        - 5003
        - 5004
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````