Skip to content

Consultar Cash Out por ID

Consulta os detalhes e o status de uma transacao PIX pelo transaction_id.

Endpoint

GET /api/external/transactions/:id

Headers

HeaderTipoObrigatorioDescricao
AuthorizationStringSimApiKey {client_id}:{client_secret}

Path Parameters

ParametroTipoObrigatorioDescricao
idStringSimID da transacao (transaction_id)

Exemplo

bash
curl -X GET https://api.owem.com.br/api/external/transactions/PIXOUT20260309a1b2c3d4e5f6 \
  -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"
  }
}

Campos da Resposta

CampoTipoDescricao
data.idStringUUID interno da transacao
data.transaction_idStringIdentificador unico da transacao
data.end_to_end_idStringIdentificador End-to-End no SPI/BACEN
data.external_idStringIdentificador do seu sistema. null se nao informado
data.typeStringTipo da transacao (pix)
data.directionStringoutbound (cash-out) ou inbound (cash-in)
data.statusStringStatus atual (ver tabela abaixo)
data.amountIntegerValor em unidades base (÷ 10.000 para reais). 300000 = R$ 30,00
data.fee_amountIntegerTarifa cobrada em unidades base
data.net_amountIntegerValor liquido em unidades base
data.descriptionStringDescricao informada na criacao
data.counterparty_nameStringNome da contraparte (pagador ou recebedor)
data.recipient_keyStringChave PIX do destinatario (apenas para saidas)
data.created_atStringData de criacao (ISO 8601)
data.completed_atStringData de conclusao (ISO 8601), null se pendente

Status da Transacao

StatusDescricao
pending_approvalAguardando aprovacao (fluxo criar + aprovar)
processingEnviada ao SPI, aguardando liquidacao
completedLiquidada com sucesso
failedRejeitada pelo SPI ou erro no processamento
refundedDevolvida (total ou parcial)

Resposta de Erro -- 404

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

Owem Pay Instituição de Pagamento — ISPB 37839059