> ## Documentation Index
> Fetch the complete documentation index at: https://docs.azentech.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar extrato

> Lista lançamentos condensados no formato usado pela integração de Open Finance.

## Comportamento observado

* O Gateway aplica o período somente quando `start_date` e `end_date` são enviados juntos.
* Sem as duas datas, a consulta atual não aplica o período padrão calculado pelo controller.
* O controller não impõe o limite de 30 dias.

> [!NOTE]
>
> Os exemplos usam identificadores e credenciais sintéticos. Os resultados do processador dependem do credenciamento e da configuração do estabelecimento.


## OpenAPI

````yaml openapi.json GET /api/merchant/statements
openapi: 3.1.0
info:
  title: Azentech Payments API
  version: 1.0.0
  description: >-
    Contrato HTTP público das operações de pagamento, consulta, sandbox e
    webhooks da Azentech. A especificação contém apenas o ambiente de
    homologação confirmado.
servers:
  - url: https://gateway.staging.azentech.dev
    description: Homologação (staging)
security: []
tags:
  - name: Pix
    description: Cobranças, pagamentos, aportes, retiradas e jornada biométrica.
  - name: Transações
    description: Consulta e reembolso de transações.
  - name: Saldos
    description: Saldos atuais, históricos e resumo financeiro.
  - name: Relatórios
    description: Extrato e posição financeira.
  - name: Sandbox
    description: Simulações disponíveis para processadores elegíveis em modo de teste.
paths:
  /api/merchant/statements:
    get:
      tags:
        - Relatórios
      summary: Consultar extrato
      description: >-
        Lista lançamentos condensados no formato usado pela integração de Open
        Finance.
      operationId: reference_reports_statements
      parameters:
        - name: start_date
          in: query
          required: false
          description: >-
            Início do período. O filtro só é aplicado quando end_date também é
            enviado.
          schema:
            type: string
            format: date-time
        - name: end_date
          in: query
          required: false
          description: >-
            Fim do período. O filtro só é aplicado quando start_date também é
            enviado.
          schema:
            type: string
            format: date-time
        - name: limit
          in: query
          required: false
          description: Itens por página. O padrão é 50.
          schema:
            type: integer
            minimum: 1
            default: 50
        - name: page
          in: query
          required: false
          description: Página solicitada.
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Página de lançamentos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatementPage'
              example:
                data:
                  - transactionIdApi: 10000000-0000-4000-8000-000000000001
                    eventId: 60000000-0000-4000-8000-000000000001
                    e2EId: E0000000020261023143000000000001
                    accountId: demo-account
                    creditDebitType: CREDITO
                    completedAuthorisedPaymentType: COMPLETED
                    transactionName: Sandbox Pix
                    type: pix
                    amount: '125.90'
                    currency: BRL
                    transactionDate: '2026-10-23T14:30:00Z'
                    postDate: '2026-10-23T14:31:00Z'
                    partieCnpjCpf: '12345678909'
                    partiePerson: PESSOA_NATURAL
                    partieCompeCode: '12345678'
                    partieBranchCode: '0001'
                    partieNumber: 123456-7
                    partieCheckDigit: ''
                    isReversal: false
                    isRefund: false
                meta:
                  current_page: 1
                  last_page: 1
                  per_page: 50
                  total: 1
        '401':
          description: Token ausente, inválido ou sem acesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message:
                    base:
                      - Not authenticated
                  status: 401
        '500':
          description: Falha interna ou falha não traduzida do processador.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message:
                    fatal: >-
                      Something went wrong. Please refer to support with the
                      following code: 0000000000
                  status: 500
      security:
        - BearerAuth: []
components:
  schemas:
    StatementPage:
      type: object
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/StatementItem'
        meta:
          type: object
          additionalProperties: false
          properties:
            current_page:
              type: integer
              description: Página atual.
            last_page:
              type: integer
              description: Última página.
            per_page:
              type: integer
              description: Itens por página.
            total:
              type: integer
              description: Total de itens.
          required:
            - current_page
            - last_page
            - per_page
            - total
      required:
        - data
        - meta
    GatewayError:
      type: object
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            message:
              oneOf:
                - type: string
                - type: object
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
              description: Mensagem simples ou mapa de campos para listas de mensagens.
            status:
              type: integer
              description: Código HTTP devolvido.
          required:
            - message
            - status
      required:
        - error
    StatementItem:
      type: object
      additionalProperties: false
      properties:
        transactionIdApi:
          type: string
          description: UUID da transação no Gateway.
          format: uuid
        eventId:
          type: string
          description: UUID do evento.
          format: uuid
        e2EId:
          type:
            - string
            - 'null'
          description: Identificador EndToEnd.
        accountId:
          type:
            - string
            - 'null'
          description: Conta do estabelecimento.
        creditDebitType:
          type: string
          description: Natureza do lançamento.
          enum:
            - CREDITO
            - DEBITO
        completedAuthorisedPaymentType:
          type: string
          description: Classificação da autorização ou conclusão.
        transactionName:
          type: string
          description: Nome do provedor.
        type:
          type: string
          description: Tipo da transação.
        amount:
          type: string
          description: Valor em reais.
        currency:
          type: string
          description: Moeda do lançamento.
        transactionDate:
          type: string
          description: Data e hora inicial.
          format: date-time
        postDate:
          type: string
          description: Data e hora final.
          format: date-time
        partieCnpjCpf:
          type: string
          description: CPF ou CNPJ da contraparte.
        partiePerson:
          type: string
          description: Tipo da contraparte.
          enum:
            - PESSOA_NATURAL
            - PESSOA_JURIDICA
        partieCompeCode:
          type:
            - string
            - 'null'
          description: ISPB da contraparte.
        partieBranchCode:
          type:
            - string
            - 'null'
          description: Agência da contraparte.
        partieNumber:
          type:
            - string
            - 'null'
          description: Conta da contraparte.
        partieCheckDigit:
          type:
            - string
            - 'null'
          description: Dígito da conta. O Gateway atual envia string vazia.
        isReversal:
          type: boolean
        isRefund:
          type: boolean
      required:
        - transactionIdApi
        - eventId
        - creditDebitType
        - completedAuthorisedPaymentType
        - transactionName
        - type
        - amount
        - currency
        - transactionDate
        - postDate
        - partieCnpjCpf
        - partiePerson
        - isReversal
        - isRefund
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: Token de acesso fornecido para o estabelecimento.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.