Query Cash-In by Tag

Queries PIX transactions that match a tag (prefix of the transaction_id).

Endpoint

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

Headers

Header	Type	Required	Description
Authorization	String	Yes	ApiKey {client_id}:{client_secret}
X-Key-Case	String	No	Set to camelCase to receive response fields in camelCase (default is snake_case)

Path Parameters

Parameter	Type	Required	Description
tag	String	Yes	Prefix of the transaction_id for search

Tag prefixes

The transaction_id follows the pattern PIXIN (receipts) and PIXOUT (sends) followed by the date. Use PIXIN20260307 to search all receipts on 2026-03-07.

Example

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

Success Response (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"
    }
  ]
}

Field	Type	Description
worked	Boolean	true indicates operation success
data	Array	List of transactions matching the tag (hard limit of 50 records per query, ordered by started_at DESC)

Each object in the array follows the same structure described in Query by ID. Monetary values in base units (÷ 10,000 for BRL).

Limit and pagination

The endpoint returns at most 50 results per query, ordered from most recent to oldest (started_at DESC). There are no pagination parameters -- if you need more results, combine the tag with a narrower date filter (e.g., PIXIN20260307 for the specific day) or use Query by E2E for individual entries.

Success Response -- No Results (200)

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

Error Response (401)

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

Cash-In and Cash-Out

This endpoint returns both inbound and outbound transactions that match the tag. Filter by the PIXIN prefix to get only receipts or PIXOUT to get only sends.