按 Tag 查询 Cash-In

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

端点

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

请求头

头	类型	必填	描述
Authorization	String	是	ApiKey {client_id}:{client_secret}
X-Key-Case	String	否	设为 camelCase 以使用 camelCase 接收响应字段（默认 snake_case）

路径参数

参数	类型	必填	描述
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": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d",
      "transaction_id": "7popu57v6us7p6pcicgq12345",
      "end_to_end_id": "E37839059202603071530000001",
      "external_id": "order-9876",
      "type": "pix",
      "status": "settled",
      "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": "f7e8d9c0b1a24c3d9e8f7a6b5c4d3e2f",
      "transaction_id": "7popu57v6us7p6pcicgq67890",
      "end_to_end_id": "E37839059202603071545000002",
      "external_id": null,
      "type": "pix",
      "status": "settled",
      "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 匹配的交易列表（每次查询固定上限 50 条,按 started_at DESC 排序）

数组中的每个对象遵循 按 ID 查询 中描述的相同结构。货币值以基础单位（÷ 10.000 得到雷亚尔）。

限制和分页

端点每次查询最多返回 50 条结果,从最新到最旧（started_at DESC）排序。没有分页参数 -- 如果需要更多结果,请将 tag 与更窄的日期过滤器组合使用（例：PIXIN20260307 指定日期）或使用 按 E2E 查询 查单条入款。

成功响应 -- 无结果 (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 仅获取出款。