v2
latestOpenAPI 3.1.02026-07-314524165.2 KBListar 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
beforestring
Cursor para buscar itens antes deste ponto
limitinteger
Example:100
Quantidade de itens por página (1-100)
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.
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
}