Skip to content

Consultar Cash Out por ID

Consulta los detalles y el estado de una transaccion PIX por el transaction_id.

Endpoint

GET /api/external/transactions/:id

Headers

HeaderTipoObligatorioDescripcion
AuthorizationStringSiApiKey {client_id}:{client_secret}

Path Parameters

ParametroTipoObligatorioDescripcion
idStringSiID de la transaccion (transaction_id)

Ejemplo

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

Respuesta de Exito -- 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 de la Respuesta

CampoTipoDescripcion
data.idStringUUID interno de la transaccion
data.transaction_idStringIdentificador unico de la transaccion
data.end_to_end_idStringIdentificador End-to-End en el SPI/BACEN
data.external_idStringIdentificador de su sistema. null si no fue informado
data.typeStringTipo de la transaccion (pix)
data.directionStringoutbound (cash-out) o inbound (cash-in)
data.statusStringEstado actual (ver tabla a continuacion)
data.amountIntegerValor en unidades base (/ 10.000 para reales). 300000 = R$ 30,00
data.fee_amountIntegerTarifa cobrada en unidades base
data.net_amountIntegerValor neto en unidades base
data.descriptionStringDescripcion informada en la creacion
data.counterparty_nameStringNombre de la contraparte (pagador o receptor)
data.recipient_keyStringClave PIX del destinatario (solo para envios)
data.created_atStringFecha de creacion (ISO 8601)
data.completed_atStringFecha de conclusion (ISO 8601), null si pendiente

Estado de la Transaccion

EstadoDescripcion
pending_approvalEsperando aprobacion (flujo crear + aprobar)
processingEnviada al SPI, esperando liquidacion
completedLiquidada con exito
failedRechazada por el SPI o error en el procesamiento
refundedDevuelta (total o parcial)

Respuesta de Error -- 404

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

Owem Pay Instituição de Pagamento — ISPB 37839059