Query Cash Out by Tag

Queries PIX transactions matching a tag (prefix of transaction_id). Allows grouping and searching transactions by date, type, or any identifier prefix.

Endpoint

GET /api/v2/external/transactions/tag/{tag}

Headers

Header	Type	Required	Description
Authorization	String	Yes	Bearer {access_token}

Path Parameters

Parameter	Type	Required	Description
tag	String	Yes	transaction_id prefix for search

Tag search examples

• PIXOUT20260309 — all outbound PIX transfers from 2026-03-09
• PIXOUT — all outbound PIX transfers
• PIXIN20260309 — all PIX receipts from 2026-03-09

Example

curl -X GET https://api.owem.com.br/api/v2/external/transactions/tag/PIXOUT20260309 \
  -H "Authorization: Bearer $TOKEN"

Success Response — 200

{
  "worked": true,
  "data": [
    {
      "id": "c7f3a8b1-2d4e-4f6a-9c1b-3e5f7a9b1d3e",
      "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603091530abcdef01",
      "type": "pix",
      "direction": "outbound",
      "status": "completed",
      "amount": 10000,
      "fee": 0,
      "description": "Supplier payment",
      "created_at": "2026-03-09T15:30:00Z",
      "updated_at": "2026-03-09T15:30:02Z"
    },
    {
      "id": "d8e4b9c2-3f5a-5b7c-0d2e-4f6a8b0c2e4f",
      "transaction_id": "PIXOUT20260309f6e5d4c3b2a1",
      "end_to_end_id": "E37839059202603091545abcdef02",
      "type": "pix",
      "direction": "outbound",
      "status": "processing",
      "amount": 25000,
      "fee": 0,
      "description": "Service payment",
      "created_at": "2026-03-09T15:45:00Z",
      "updated_at": "2026-03-09T15:45:00Z"
    }
  ]
}

Field	Type	Description
data	Array	List of transactions matching the prefix

Each object in the array follows the same structure as the query by ID.

Result limit

The tag search returns a maximum of 50 transactions per request. Use more specific prefixes (e.g., full date) to refine results.

Empty Response — 200

When no transactions match the provided prefix:

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