Skip to content

Consultar Cash In por ID

Consulta el estado y detalles de una transaccion PIX por el ID de la transaccion.

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/7popu57v6us7p6pcicgq12345 \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

Respuesta de Exito (200)

json
{
  "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"
  }
}
CampoTipoDescripcion
workedBooleantrue indica exito en la operacion
data.idStringUUID interno de la transaccion
data.transaction_idStringIdentificador publico de la transaccion
data.end_to_end_idStringID punto a punto del BACEN (E2E)
data.external_idStringIdentificador de su sistema. null si no fue informado en la creacion
data.typeStringTipo de la transaccion (pix)
data.statusStringEstado actual (ver tabla a continuacion)
data.amountIntegerValor en unidades base (/ 10.000 para reales). 300000 = R$ 30,00
data.fee_amountIntegerValor de la tarifa en unidades base
data.net_amountIntegerValor neto en unidades base
data.descriptionStringDescripcion de la transaccion
data.directionStringinbound para cobros
data.counterparty_nameStringNombre del pagador
data.created_atStringFecha de creacion (ISO 8601)
data.completed_atStringFecha de conclusion (ISO 8601), null si pendiente

Estados Posibles

EstadoDescripcion
activeQR Code generado, esperando pago
pendingPago detectado, en procesamiento
completedPago confirmado
failedPago fallo
cancelledCobro cancelado o expirado

Respuesta de Error (404)

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

Respuesta de Error (401)

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

Polling vs Webhook

Para acompanar el estado de un cobro, prefiera utilizar Webhooks en vez de polling. En caso de necesitar consultar, use intervalos de al menos 5 segundos.

Owem Pay Instituição de Pagamento — ISPB 37839059