Skip to content

Query Cash Out by ID

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

Endpoint

GET /api/external/transactions/:id

Headers

HeaderTypeRequiredDescription
AuthorizationStringYesApiKey {client_id}:{client_secret}

Path Parameters

ParameterTypeRequiredDescription
idStringYesTransaction ID (transaction_id)

Example

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

Success Response -- 200

json
{
  "worked": true,
  "data": {
    "id": "c7f3a8b1-2d4e-4f6a-9c1b-3e5f7a9b1d3e",
    "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603091530abcdef01",
    "external_id": "order-9876",
    "type": "pix",
    "direction": "outbound",
    "status": "completed",
    "amount": 300000,
    "fee_amount": 350,
    "net_amount": 300350,
    "description": "Pagamento fornecedor",
    "counterparty_name": "Joao Silva",
    "recipient_key": "12345678901",
    "created_at": "2026-03-09T15:30:00Z",
    "completed_at": "2026-03-09T15:30:02Z"
  }
}

Response Fields

FieldTypeDescription
data.idStringInternal transaction UUID
data.transaction_idStringUnique transaction identifier
data.end_to_end_idStringEnd-to-End identifier in SPI/BACEN
data.external_idStringYour system identifier. null if not provided
data.typeStringTransaction type (pix)
data.directionStringoutbound (cash-out) or inbound (cash-in)
data.statusStringCurrent status (see table below)
data.amountIntegerAmount in base units (/ 10,000 for BRL). 300000 = R$ 30.00
data.fee_amountIntegerFee charged in base units
data.net_amountIntegerNet amount in base units
data.descriptionStringDescription provided at creation
data.counterparty_nameStringCounterparty name (payer or recipient)
data.recipient_keyStringRecipient PIX key (outbound only)
data.created_atStringCreation date (ISO 8601)
data.completed_atStringCompletion date (ISO 8601), null if pending

Transaction Status

StatusDescription
pending_approvalAwaiting approval (create + approve flow)
processingSent to SPI, awaiting settlement
completedSuccessfully settled
failedRejected by SPI or processing error
refundedReturned (fully or partially)

Error Response -- 404

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

Owem Pay Instituição de Pagamento — ISPB 37839059