Skip to content

Consultar Cash-In por Tag

Consulta transacciones PIX que corresponden a una tag (prefijo del transaction_id).

Endpoint

GET /api/external/transactions/tag/:tag

Headers

HeaderTipoObligatorioDescripcion
AuthorizationStringSiApiKey {client_id}:{client_secret}
X-Key-CaseStringNoDefina como camelCase para recibir los campos de la respuesta en camelCase (default es snake_case)

Path Parameters

ParametroTipoObligatorioDescripcion
tagStringSiPrefijo del transaction_id para busqueda

Prefijos de Tag

Los transaction_id siguen el patron PIXIN (recibimientos) y PIXOUT (envios) seguido de la fecha. Use PIXIN20260307 para buscar todos los recibimientos de 07/03/2026.

Ejemplo

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

Respuesta de Exito (200)

json
{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d",
      "transaction_id": "7popu57v6us7p6pcicgq12345",
      "end_to_end_id": "E37839059202603071530000001",
      "external_id": "order-9876",
      "type": "pix",
      "status": "settled",
      "amount": 300000,
      "fee_amount": 0,
      "net_amount": 300000,
      "direction": "inbound",
      "counterparty_name": "Maria Santos",
      "created_at": "2026-03-07T15:30:00Z",
      "completed_at": "2026-03-07T15:30:02Z"
    },
    {
      "id": "f7e8d9c0b1a24c3d9e8f7a6b5c4d3e2f",
      "transaction_id": "7popu57v6us7p6pcicgq67890",
      "end_to_end_id": "E37839059202603071545000002",
      "external_id": null,
      "type": "pix",
      "status": "settled",
      "amount": 2500000,
      "fee_amount": 0,
      "net_amount": 2500000,
      "direction": "inbound",
      "counterparty_name": "Joao Silva",
      "created_at": "2026-03-07T15:45:00Z",
      "completed_at": "2026-03-07T15:45:03Z"
    }
  ]
}
CampoTipoDescripcion
workedBooleantrue indica exito en la operacion
dataArrayLista de transacciones que corresponden a la tag (limite fijo de 50 registros por consulta, ordenado por started_at DESC)

Cada objeto en el array sigue la misma estructura descrita en Consultar por ID. Valores monetarios en unidades base (÷ 10.000 para reales).

Limite y paginacion

El endpoint retorna como maximo 50 resultados por consulta, ordenados del mas reciente al mas antiguo (started_at DESC). No hay parametros de paginacion -- si necesita mas resultados, combine la tag con un filtro de fecha mas estrecho (ej: PIXIN20260307 para el dia especifico) o utilice Consultar por E2E para entradas individuales.

Respuesta de Exito -- Sin Resultados (200)

json
{
  "worked": true,
  "data": []
}

Respuesta de Error (401)

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

Cash-In y Cash-Out

Este endpoint retorna tanto transacciones de entrada como de salida que correspondan a la tag. Filtre por el prefijo PIXIN para obtener solo recibimientos o PIXOUT para solo envios.

Owem Pay Instituição de Pagamento — ISPB 37839059