---
title: "Listar PIX"
method: GET
path: "/pix/list"
---

# Listar PIX

`GET /pix/list`

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

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `startDate` string, date
- `endDate` string, date
- `id` string
- `externalId` string
- `status` 'PENDING' | 'EXPIRED' | 'CANCELLED' | 'COMPLETE' | 'REFUNDED'

## Response `200`

Lista de PIX retornada com sucesso.

- object
  - `data` PixTransaction[] — Lista de transações PIX criadas.
    - `id` string, required — Identificador único da transação PIX.
    - `status` 'PENDING' | 'EXPIRED' | 'CANCELLED' | 'COMPLETE' | 'REFUNDED', required — Status atual da transação.
    - `devMode` boolean, required — Indica se a transação foi criada em ambiente de testes.
    - `receiptUrl` string, uri, required — URL do comprovante da transação.
    - `amount` number, required — Valor da transação em centavos.
    - `platformFee` number, required — Taxa da plataforma em centavos.
    - `externalId` string, nullable — Identificador externo da transação.
    - `createdAt` string, date-time, required — Data de criação da transação.
    - `updatedAt` string, date-time, required — Data de atualização da transação.
  - `success` boolean — Se a requisição obteve sucesso ou não.
  - `error` string, nullable
  - `pagination` PaginationCursor — Informações de paginação baseada em cursor.
    - `hasMore` boolean, required — Indica se existe mais itens para carregar.
    - `next` string, nullable, required — Cursor para próxima página (usar em after).
    - `before` string, nullable, required — Cursor para página anterior (usar em before).

## Other responses

- `401` — Não autorizado. Falha na autenticação.

---

[API](https://skmtc.net/abacatepay/apis/api-abacatepay.md) · [All operations](https://skmtc.net/abacatepay/apis/api-abacatepay/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/abacatepay/api-abacatepay/revisions/2153a0f133cb/schema)