按 PIX 密钥列出交易
GET /api/pix/transactions/pix-key/{pixKey}
返回与特定 PIX 密钥关联的交易,支持分页。
功能特点:
- 金额转换为巴西雷亚尔(2 位小数)
- 状态和类型映射为显示标签
- 对手方证件已脱敏
startDate和endDate之间最大间隔为 31 天- 默认
startDate:最近 30 天 - 最大结果限制为 1000 条
认证
需要在 Authorization 头中提供 Bearer 令牌。
路径参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
pixKey | string | 是 | PIX 密钥(CPF、CNPJ、手机号、邮箱或随机 EVP 密钥) |
查询参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
page | integer | 否 | 页码(从 1 开始)。默认值:1 |
size | integer | 否 | 每页记录数(最大 1000)。默认值:20 |
status | string | 否 | 按状态筛选:PENDING、CONFIRMED、ERROR |
type | string | 否 | 按类型筛选:PAYMENT、WITHDRAW、REFUND_IN、REFUND_OUT |
startDate | string | 否 | 开始日期(ISO 8601)。默认值:最近 30 天 |
endDate | string | 否 | 结束日期(ISO 8601)。默认值:当前日期 |
响应 (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
}
}错误
| 状态码 | 描述 |
|---|---|
| 400 | 参数无效或日期范围超过 31 天 |
| 401 | 令牌缺失或无效 |