Query Cash In by ID

Queries the status and details of a PIX transaction by transaction ID.

Endpoint

GET /api/external/transactions/:id

Headers

Header	Type	Required	Description
Authorization	String	Yes	ApiKey {client_id}:{client_secret}

Path Parameters

Parameter	Type	Required	Description
id	String	Yes	Transaction ID (transaction_id)

Example

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

Success Response (200)

{
  "worked": true,
  "data": {
    "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "transaction_id": "7popu57v6us7p6pcicgq12345",
    "end_to_end_id": "E37839059202603071530000001",
    "external_id": "order-9876",
    "type": "pix",
    "status": "completed",
    "amount": 300000,
    "fee_amount": 0,
    "net_amount": 300000,
    "description": "Pedido #1234",
    "direction": "inbound",
    "counterparty_name": "Maria Santos",
    "created_at": "2026-03-07T15:30:00Z",
    "completed_at": "2026-03-07T15:30:02Z"
  }
}

Field	Type	Description
worked	Boolean	true indicates operation success
data.id	String	Internal transaction UUID
data.transaction_id	String	Public transaction identifier
data.end_to_end_id	String	BACEN End-to-End ID (E2E)
data.external_id	String	Your system identifier. null if not provided at creation
data.type	String	Transaction type (pix)
data.status	String	Current status (see table below)
data.amount	Integer	Amount in base units (/ 10,000 for BRL). 300000 = R$ 30.00
data.fee_amount	Integer	Fee amount in base units
data.net_amount	Integer	Net amount in base units
data.description	String	Transaction description
data.direction	String	inbound for receipts
data.counterparty_name	String	Payer name
data.created_at	String	Creation date (ISO 8601)
data.completed_at	String	Completion date (ISO 8601), null if pending

Possible Statuses

Status	Description
active	QR Code generated, awaiting payment
pending	Payment detected, processing
completed	Payment confirmed
failed	Payment failed
cancelled	Charge cancelled or expired

Error Response (404)

{
  "worked": false,
  "detail": "Transacao nao encontrada"
}

Error Response (401)

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

Polling vs Webhook

To track charge status, prefer using Webhooks instead of polling. If you need to query, use intervals of at least 5 seconds.