按 Tag 查询 Cash Out

查询与指定 tag（transaction_id 前缀）匹配的 PIX 交易。可按日期、类型或标识符的任意前缀分组和搜索交易。

端点

GET /api/external/transactions/tag/:tag

请求头

头	类型	必填	描述
Authorization	String	是	ApiKey {client_id}:{client_secret}

路径参数

参数	类型	必填	描述
tag	String	是	transaction_id 的前缀，用于搜索

按 tag 搜索示例

• PIXOUT20260309 -- 2026 年 3 月 9 日的所有 PIX 付款
• PIXOUT -- 所有 PIX 付款
• PIXIN20260309 -- 2026 年 3 月 9 日的所有 PIX 收款

示例

curl -X GET https://api.owem.com.br/api/external/transactions/tag/PIXOUT20260309 \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

成功响应 -- 200

{
  "worked": true,
  "data": [
    {
      "id": "c7f3a8b1-2d4e-4f6a-9c1b-3e5f7a9b1d3e",
      "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603091530abcdef01",
      "external_id": "order-9876",
      "type": "pix",
      "direction": "outbound",
      "status": "completed",
      "amount": 300000,
      "fee_amount": 350,
      "net_amount": 300350,
      "description": "Pagamento fornecedor",
      "counterparty_name": "Joao Silva",
      "recipient_key": "12345678901",
      "created_at": "2026-03-09T15:30:00Z",
      "completed_at": "2026-03-09T15:30:02Z"
    },
    {
      "id": "d8e4b9c2-3f5a-5b7c-0d2e-4f6a8b0c2e4f",
      "transaction_id": "PIXOUT20260309f6e5d4c3b2a1",
      "end_to_end_id": "E37839059202603091545abcdef02",
      "external_id": null,
      "type": "pix",
      "direction": "outbound",
      "status": "processing",
      "amount": 2500000,
      "fee_amount": 350,
      "net_amount": 2500350,
      "description": "Pagamento servico",
      "counterparty_name": "Maria Santos",
      "recipient_key": "98765432100",
      "created_at": "2026-03-09T15:45:00Z",
      "completed_at": null
    }
  ]
}

字段	类型	描述
data	Array	与前缀匹配的交易列表

数组中每个对象遵循与按 ID 查询相同的结构。货币金额以基本单位表示（/ 10,000 = 雷亚尔）。

结果限制

按 tag 搜索每次请求最多返回 50 笔交易。请使用更具体的前缀（如：完整日期）以细化结果。

空结果响应 -- 200

当没有交易与指定前缀匹配时：

{
  "worked": true,
  "data": []
}