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

# Listar PIX

> Permite que você recupere uma lista de transações PIX criadas.

Você pode filtrar usando:
- `id`: Identificador único da transação PIX na AbacatePay
- `externalId`: Identificador único do PIX em seu sistema
- `status`: Status da transação


Retorna todas as transações PIX enviadas pela sua conta.

<Card horizontal>
  Requer a permissão `WITHDRAW:READ`.
</Card>

Use `limit`, `after` e `before` para paginar. Cada item segue o mesmo formato da resposta do [Enviar PIX](/pages/pix/create), incluindo `status`, `amount`, `platformFee` e `receiptUrl`.


## OpenAPI

````yaml GET /pix/list
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /pix/list:
    get:
      summary: Listar PIX
      description: |
        Permite que você recupere uma lista de transações PIX criadas.

        Você pode filtrar usando:
        - `id`: Identificador único da transação PIX na AbacatePay
        - `externalId`: Identificador único do PIX em seu sistema
        - `status`: Status da transação
      parameters:
        - name: after
          in: query
          description: Cursor para buscar itens após este ponto
          required: false
          schema:
            type: string
        - name: before
          in: query
          description: Cursor para buscar itens antes deste ponto
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: Quantidade de itens por página (1-100)
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
            example: 100
        - name: id
          in: query
          description: Filtrar por identificador único da transação PIX na AbacatePay
          required: false
          schema:
            type: string
            example: txn_abc123xyz
        - name: externalId
          in: query
          description: Filtrar por identificador do PIX em seu sistema
          required: false
          schema:
            type: string
            example: pix-123
        - name: status
          in: query
          description: Filtrar por status da transação
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - EXPIRED
              - CANCELLED
              - COMPLETE
              - REFUNDED
      responses:
        '200':
          description: Lista de PIX retornada com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Lista de transações PIX criadas.
                    items:
                      $ref: '#/components/schemas/PixTransaction'
                  success:
                    $ref: '#/components/schemas/Success'
                  error:
                    type: string
                    nullable: true
                    example: null
                  pagination:
                    $ref: '#/components/schemas/PaginationCursor'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  schemas:
    PixTransaction:
      type: object
      description: Dados de uma transação PIX.
      properties:
        id:
          type: string
          description: Identificador único da transação PIX.
          example: txn_abc123xyz
        status:
          type: string
          description: Status atual da transação.
          enum:
            - PENDING
            - EXPIRED
            - CANCELLED
            - COMPLETE
            - REFUNDED
          example: PENDING
        devMode:
          type: boolean
          description: Indica se a transação foi criada em ambiente de testes.
          example: false
        receiptUrl:
          type: string
          format: uri
          description: URL do comprovante da transação.
          example: https://app.abacatepay.com/receipt/txn_abc123xyz
        amount:
          type: number
          description: Valor da transação em centavos.
          example: 10000
        platformFee:
          type: number
          description: Taxa da plataforma em centavos.
          example: 100
        externalId:
          type: string
          nullable: true
          description: Identificador externo da transação.
          example: pix-123
        createdAt:
          type: string
          format: date-time
          description: Data de criação da transação.
          example: '2024-11-04T18:38:28.573Z'
        updatedAt:
          type: string
          format: date-time
          description: Data de atualização da transação.
          example: '2024-11-04T18:38:28.573Z'
      required:
        - id
        - status
        - devMode
        - receiptUrl
        - amount
        - platformFee
        - createdAt
        - updatedAt
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
    PaginationCursor:
      type: object
      description: Informações de paginação baseada em cursor.
      required:
        - hasMore
        - next
        - before
      additionalProperties: false
      properties:
        hasMore:
          type: boolean
          description: Indica se existe mais itens para carregar.
        next:
          type: string
          nullable: true
          description: Cursor para próxima página (usar em after).
        before:
          type: string
          nullable: true
          description: Cursor para página anterior (usar em before).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````