Listar transacciones por clave PIX
GET /api/pix/transactions/pix-key/{pixKey}
Retorna las transacciones asociadas a una clave PIX específica con paginación.
Características:
- Montos convertidos a BRL (2 decimales)
- Estados y tipos mapeados a etiquetas de visualización
- Documentos de la contraparte enmascarados
- Intervalo máximo de 31 días entre
startDateyendDate startDatepor defecto: últimos 30 días- Límite máximo de 1000 resultados totales
Autenticación
Requiere un Bearer token en el header Authorization.
Parámetros de ruta
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
pixKey | string | Sí | Clave PIX (CPF, CNPJ, teléfono, email o clave EVP aleatoria) |
Parámetros de consulta
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
page | integer | No | Número de página (indexado desde 1). Por defecto: 1 |
size | integer | No | Cantidad de registros por página (máx 1000). Por defecto: 20 |
status | string | No | Filtrar por estado: PENDING, CONFIRMED, ERROR |
type | string | No | Filtrar por tipo: PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT |
startDate | string | No | Fecha de inicio (ISO 8601). Por defecto: últimos 30 días |
endDate | string | No | Fecha de fin (ISO 8601). Por defecto: fecha actual |
Respuesta (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
}
}Errores
| Estado | Descripción |
|---|---|
| 400 | Parámetros inválidos o rango de fechas excede 31 días |
| 401 | Token faltante o inválido |