按 Tag 查询 Cash In

查询与指定 tag（transaction_id 前缀）匹配的 PIX 交易。

端点

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

请求头

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

路径参数

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

Tag 前缀

transaction_id 遵循 PIXIN（收款）和 PIXOUT（付款）加日期的格式。使用 PIXIN20260307 可搜索 2026 年 3 月 7 日的所有收款。

示例

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

成功响应 (200)

{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "transaction_id": "7popu57v6us7p6pcicgq12345",
      "end_to_end_id": "E37839059202603071530000001",
      "external_id": "order-9876",
      "type": "pix",
      "status": "completed",
      "amount": 300000,
      "fee_amount": 0,
      "net_amount": 300000,
      "direction": "inbound",
      "counterparty_name": "Maria Santos",
      "created_at": "2026-03-07T15:30:00Z",
      "completed_at": "2026-03-07T15:30:02Z"
    },
    {
      "id": "f7e8d9c0-b1a2-4c3d-9e8f-7a6b5c4d3e2f",
      "transaction_id": "7popu57v6us7p6pcicgq67890",
      "end_to_end_id": "E37839059202603071545000002",
      "external_id": null,
      "type": "pix",
      "status": "completed",
      "amount": 2500000,
      "fee_amount": 0,
      "net_amount": 2500000,
      "direction": "inbound",
      "counterparty_name": "Joao Silva",
      "created_at": "2026-03-07T15:45:00Z",
      "completed_at": "2026-03-07T15:45:03Z"
    }
  ]
}

字段	类型	描述
worked	Boolean	true 表示操作成功
data	Array	与 tag 匹配的交易列表

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

成功响应 -- 无结果 (200)

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

错误响应 (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

Cash In 和 Cash Out

此端点同时返回与 tag 匹配的收款和付款交易。使用 PIXIN 前缀筛选仅收款，PIXOUT 前缀筛选仅付款。