Skip to content

Query Cash In by Tag

Queries PIX transactions matching a tag (prefix of transaction_id).

Endpoint

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

Headers

HeaderTypeRequiredDescription
AuthorizationStringYesBearer {access_token}

Path Parameters

ParameterTypeRequiredDescription
tagStringYestransaction_id prefix 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 from 2026-03-07.

Example

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

Success Response (200)

json
{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603071530000001",
      "type": "pix",
      "status": "completed",
      "amount": 10000,
      "fee_amount": 0,
      "net_amount": 10000,
      "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": "PIXIN20260307x9y8z7w6v5u4",
      "end_to_end_id": "E37839059202603071545000002",
      "type": "pix",
      "status": "completed",
      "amount": 25000,
      "fee_amount": 0,
      "net_amount": 25000,
      "direction": "inbound",
      "counterparty_name": "Joao Silva",
      "created_at": "2026-03-07T15:45:00Z",
      "completed_at": "2026-03-07T15:45:03Z"
    }
  ]
}
FieldTypeDescription
workedBooleantrue indicates operation success
dataArrayList of transactions matching the tag

Each object in the array follows the same structure described in Query by ID.

Success Response -- No Results (200)

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

Error Response (401)

json
{
  "worked": false,
  "detail": "Invalid or expired token"
}

Cash In and Cash Out

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

Owem Pay Instituição de Pagamento — ISPB 37839059