Skip to main content
GET
/
pix
/
list
Listar PIX
curl --request GET \
  --url https://api.abacatepay.com/v2/pix/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "txn_abc123xyz",
      "status": "PENDING",
      "devMode": false,
      "receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
      "amount": 10000,
      "platformFee": 100,
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z",
      "externalId": "pix-123"
    }
  ],
  "success": true,
  "error": null,
  "pagination": {
    "hasMore": true,
    "next": "<string>",
    "before": "<string>"
  }
}
Retorna todas as transações PIX enviadas pela sua conta.

Requer a permissão WITHDRAW:READ.
Use limit, after e before para paginar. Cada item segue o mesmo formato da resposta do Enviar PIX, incluindo status, amount, platformFee e receiptUrl.

Authorizations

​
Authorization
string
header
required

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.

Query Parameters

​
after
string

Cursor para buscar itens após este ponto

​
before
string

Cursor para buscar itens antes deste ponto

​
limit
integer
default:100

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

Required range: 1 <= x <= 100
Example:

100

​
id
string

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

Example:

"txn_abc123xyz"

​
externalId
string

Filtrar por identificador do PIX em seu sistema

Example:

"pix-123"

​
status
enum<string>

Filtrar por status da transação

Available options:
PENDING,
EXPIRED,
CANCELLED,
COMPLETE,
REFUNDED

Response

Lista de PIX retornada com sucesso.

​
data
object[]

Lista de transações PIX criadas.

​
success
boolean

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

Example:

true

​
error
string | null
Example:

null

​
pagination
object

Informações de paginação baseada em cursor.