Consultar Transacao por External ID

Consulta uma transacao pelo external_id, o identificador definido pelo seu sistema no momento da criacao (cash-in ou cash-out).

Endpoint

GET /api/external/transactions/ref/:external_id

Headers

Header	Tipo	Obrigatorio	Descricao
`Authorization`	String	Sim	`ApiKey {client_id}:{client_secret}`

Path Parameters

Parametro	Tipo	Obrigatorio	Descricao
`external_id`	String	Sim	Identificador externo definido na criacao da transacao

Quando usar

Este endpoint e util para conciliacao entre o seu sistema e a Owem Pay. Em vez de armazenar o transaction_id da Owem, consulte diretamente pelo ID do seu pedido, fatura ou referencia interna.

Exemplo

bash

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

Resposta de Sucesso -- 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"
  }
}

A estrutura de resposta e identica a consulta por ID. Todos os valores monetarios estao em unidades base (÷ 10.000 para reais).

Resposta de Erro -- 404

json

{
  "worked": false,
  "detail": "Transacao nao encontrada para o external_id informado"
}

Unicidade

O external_id nao e unico por conta. Se multiplas transacoes possuem o mesmo external_id, o endpoint retorna a mais recente. Recomendamos usar valores unicos para facilitar a conciliacao.

Consultar Transacao por External ID ​

Endpoint ​

Headers ​

Path Parameters ​

Exemplo ​

Resposta de Sucesso -- 200 ​