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/:idHeaders
| Header | Tipo | Obligatorio | Descripcion |
|---|---|---|---|
Authorization | String | Si | ApiKey {client_id}:{client_secret} |
Path Parameters
| Parametro | Tipo | Obligatorio | Descripcion |
|---|---|---|---|
id | String | Si | ID 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"
}
}| Campo | Tipo | Descripcion |
|---|---|---|
worked | Boolean | true indica exito en la operacion |
data.id | String | UUID interno de la transaccion |
data.transaction_id | String | Identificador publico de la transaccion |
data.end_to_end_id | String | ID punto a punto del BACEN (E2E) |
data.external_id | String | Identificador de su sistema. null si no fue informado en la creacion |
data.type | String | Tipo de la transaccion (pix) |
data.status | String | Estado actual (ver tabla a continuacion) |
data.amount | Integer | Valor en unidades base (/ 10.000 para reales). 300000 = R$ 30,00 |
data.fee_amount | Integer | Valor de la tarifa en unidades base |
data.net_amount | Integer | Valor neto en unidades base |
data.description | String | Descripcion de la transaccion |
data.direction | String | inbound para cobros |
data.counterparty_name | String | Nombre del pagador |
data.created_at | String | Fecha de creacion (ISO 8601) |
data.completed_at | String | Fecha de conclusion (ISO 8601), null si pendiente |
Estados Posibles
| Estado | Descripcion |
|---|---|
active | QR Code generado, esperando pago |
pending | Pago detectado, en procesamiento |
completed | Pago confirmado |
failed | Pago fallo |
cancelled | Cobro 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.