v3

latestOpenAPI 3.1.02026-08-044524163.2 KB

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

get/pix/list

Query parameters

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger

Example:100

Quantidade de itens por página (1-100).

startDatestring date

Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date

Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring

Example:txn_abc123xyz

Filtrar por identificador único da transação PIX na AbacatePay

externalIdstring

Example:pix-123

Filtrar por identificador do PIX em seu sistema

status'PENDING' | 'EXPIRED' | 'CANCELLED' | 'COMPLETE' | 'REFUNDED'

Filtrar por status da transação

Response

Lista de PIX retornada com sucesso.

successboolean

Se a requisição obteve sucesso ou não.

errorstring nullable

Example response

{
  "data": [
    {
      "id": "txn_abc123xyz",
      "status": "PENDING",
      "receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
      "amount": 10000,
      "platformFee": 100,
      "externalId": "pix-123",
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true
}