List transactions by PIX key
GET /api/pix/transactions/pix-key/{pixKey}
Returns transactions associated with a specific PIX key with pagination.
Features:
- Amounts converted to BRL (2 decimal places)
- Status and types mapped to display labels
- Counterparty documents are masked
- Maximum interval of 31 days between
startDateandendDate - Default
startDate: last 30 days - Maximum limit of 1000 total results
Authentication
Requires a Bearer token in the Authorization header.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
pixKey | string | Yes | PIX key (CPF, CNPJ, phone, email, or random EVP key) |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number (1-indexed). Default: 1 |
size | integer | No | Number of records per page (max 1000). Default: 20 |
status | string | No | Filter by status: PENDING, CONFIRMED, ERROR |
type | string | No | Filter by type: PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT |
startDate | string | No | Start date (ISO 8601). Default: last 30 days |
endDate | string | No | End date (ISO 8601). Default: current date |
Response (200)
{
"data": [
{
"transactionId": "12345",
"externalId": "ext-123456",
"status": "Confirmado",
"operationType": "Pix in",
"movementType": "CREDIT",
"originalAmount": 100.00,
"feeAmount": 1.00,
"finalAmount": 99.00,
"endToEndId": "E12345678901234567890123456789012",
"createdAt": "2025-01-15T10:30:00.000Z",
"processedAt": "2025-01-15T10:30:05.000Z",
"counterpart": {
"name": "João Silva",
"document": "***.456.789-**",
"bank": {
"bankISPB": "00000000",
"bankName": "Banco do Brasil",
"bankCode": "001",
"accountBranch": "0001",
"accountNumber": "123456-7"
}
}
}
],
"metadata": {
"page": 1,
"size": 20,
"total": 150,
"totalPages": 8,
"hasNext": true,
"hasPrevious": false
}
}Errors
| Status | Description |
|---|---|
| 400 | Invalid parameters or date range exceeds 31 days |
| 401 | Missing or invalid token |