按 Tag 查询 Cash-Out

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

端点

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

请求头

头	类型	必填	描述
Authorization	String	是	ApiKey {client_id}:{client_secret}
X-Key-Case	String	否	发送 camelCase 以使用 camelCase 键接收响应（例：transactionId、endToEndId、payerIspb）。不带此头,响应保持 snake_case,如下例所示。由 FluxiqWeb.Plugs.KeyCase 应用 — 参见 身份验证

路径参数

参数	类型	必填	描述
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": "c7f3a8b12d4e4f6a9c1b3e5f7a9b1d3e",
      "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603091530abcdef01",
      "external_id": "order-9876",
      "type": "pix",
      "direction": "outbound",
      "status": "settled",
      "amount": 300000,
      "fee_amount": 350,
      "net_amount": 300350,
      "description": "Pagamento fornecedor",
      "counterparty_name": "Joao Silva",
      "recipient_key": "12345678901",
      "payer_document": "37839059000188",
      "recipient_document": "12345678901",
      "payer_ispb": "37839059",
      "payer_bank_name": "Owem Pay",
      "created_at": "2026-03-09T15:30:00Z",
      "completed_at": "2026-03-09T15:30:02Z"
    },
    {
      "id": "d8e4b9c23f5a5b7c0d2e4f6a8b0c2e4f",
      "transaction_id": "PIXOUT20260309f6e5d4c3b2a1",
      "end_to_end_id": "E37839059202603091545abcdef02",
      "external_id": null,
      "type": "pix",
      "direction": "outbound",
      "status": "settled",
      "amount": 2500000,
      "fee_amount": 350,
      "net_amount": 2500350,
      "description": "Pagamento serviço",
      "counterparty_name": "Maria Santos",
      "recipient_key": "98765432100",
      "payer_document": "37839059000188",
      "recipient_document": "98765432100",
      "payer_ispb": "37839059",
      "payer_bank_name": "Owem Pay",
      "created_at": "2026-03-09T15:45:00Z",
      "completed_at": "2026-03-09T15:45:01Z"
    }
  ]
}

字段	类型	描述
data	Array	与前缀匹配的交易列表。如果没有匹配,可能为空（[]）— 仍为 HTTP 200

搜索范围

按 tag 搜索只查询 transactions 表（已结算/拒绝的交易）。进行中的 PIX OUT（outbound_requests,stage 1-2）和未支付的 QR Code（qrcodes）不会出现在此列表中。使用 GET /transactions/:id 或 webhook pix.payout.confirmed 跟踪进行中的交易。

数组中的每个对象遵循 GET /transactions/:id 中的 "已结算交易" 响应相同的结构。货币值以基础单位（÷ 10.000 得到雷亚尔）。字段 payer_document、recipient_document、payer_ispb 和 payer_bank_name 来自交易 metadata,在旧记录中可能为 null。对于被拒绝的交易,响应包括 reason_code 和 reason_description（英文）。

结果限制

按 tag 搜索每次请求最多返回 50 条交易,按 started_at desc 排序（最新优先）。无分页 — 请使用更具体的前缀（例：一整天的 PIXOUT20260309,或一小时段的 PIXOUT2026030915）以细化结果。

空结果响应 -- 200

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

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