Consultar Cash In por ID

Consulta o status e detalhes de uma transacao PIX pelo ID da transacao.

Endpoint

GET /api/external/transactions/:id

Headers

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

Path Parameters

Parametro	Tipo	Obrigatorio	Descricao
id	String	Sim	ID da transacao (transaction_id)

Exemplo

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

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

Campo	Tipo	Descricao
worked	Boolean	true indica sucesso na operacao
data.id	String	UUID interno da transacao
data.transaction_id	String	Identificador publico da transacao
data.end_to_end_id	String	ID ponta-a-ponta do BACEN (E2E)
data.external_id	String	Identificador do seu sistema. null se nao informado na criacao
data.type	String	Tipo da transacao (pix)
data.status	String	Status atual (veja tabela abaixo)
data.amount	Integer	Valor em unidades base (÷ 10.000 para reais). 300000 = R$ 30,00
data.fee_amount	Integer	Valor da tarifa em unidades base
data.net_amount	Integer	Valor liquido em unidades base
data.description	String	Descricao da transacao
data.direction	String	inbound para recebimentos
data.counterparty_name	String	Nome do pagador
data.created_at	String	Data de criacao (ISO 8601)
data.completed_at	String	Data de conclusao (ISO 8601), null se pendente

Status Possiveis

Status	Descricao
active	QR Code gerado, aguardando pagamento
pending	Pagamento detectado, em processamento
completed	Pagamento confirmado
failed	Pagamento falhou
cancelled	Cobranca cancelada ou expirada

Resposta de Erro (404)

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

Resposta de Erro (401)

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

Polling vs Webhook

Para acompanhar o status de uma cobranca, prefira utilizar Webhooks em vez de polling. Caso precise consultar, use intervalos de no minimo 5 segundos.