Skip to content

Query Cash Out by ID

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

Endpoint

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

Headers

HeaderTypeRequiredDescription
AuthorizationStringYesBearer {access_token}

Path Parameters

ParameterTypeRequiredDescription
idStringYesTransaction ID (transaction_id)

Example

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

Success Response — 200

json
{
  "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",
    "payer": {
      "name": "Empresa Exemplo LTDA",
      "document": "12345678000199",
      "ispb": "37839059",
      "account": "100001"
    },
    "payee": {
      "name": "Joao Silva",
      "document": "***456789**",
      "ispb": "00000000",
      "account": "987654"
    },
    "created_at": "2026-03-09T15:30:00Z",
    "updated_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.typeStringTransaction type (pix)
data.directionStringDirection: outbound (cash-out) or inbound (cash-in)
data.statusStringCurrent status (see table below)
data.amountIntegerAmount in cents
data.feeIntegerFee charged in cents
data.descriptionStringDescription provided at creation
data.payerObjectPayer data
data.payer.nameStringPayer name
data.payer.documentStringPayer CPF/CNPJ
data.payer.ispbStringPayer institution ISPB
data.payer.accountStringPayer account
data.payeeObjectPayee data
data.payee.nameStringPayee name
data.payee.documentStringPayee CPF/CNPJ (masked)
data.payee.ispbStringPayee institution ISPB
data.payee.accountStringPayee account
data.created_atStringCreation date (ISO 8601)
data.updated_atStringLast update date (ISO 8601)

Transaction Status

StatusDescription
pending_approvalAwaiting approval (create + approve flow)
processingSent to SPI, awaiting settlement
completedSuccessfully settled
failedRejected by SPI or processing error
refundedRefunded (total or partial)

Error Response — 404

json
{
  "worked": false,
  "detail": "Transaction not found"
}

Owem Pay Instituição de Pagamento — ISPB 37839059