Consultar Cash-In por Tag

Consulta transações PIX que correspondem a uma tag (prefixo do transaction_id).

Endpoint

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

Headers

Header	Tipo	Obrigatório	Descrição
Authorization	String	Sim	ApiKey {client_id}:{client_secret}
X-Key-Case	String	Não	Defina como camelCase para receber os campos da resposta em camelCase (padrão é snake_case)

Path Parameters

Parâmetro	Tipo	Obrigatório	Descrição
tag	String	Sim	Prefixo do transaction_id para busca

Prefixos de Tag

Os transaction_id seguem o padrão PIXIN (recebimentos) e PIXOUT (envios) seguido da data. Use PIXIN20260307 para buscar todos os recebimentos de 07/03/2026.

Exemplo

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

Resposta de Sucesso (200)

{
  "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"
    }
  ]
}

Campo	Tipo	Descrição
worked	Boolean	true indica sucesso na operação
data	Array	Lista de transações que correspondem à tag (limite fixo de 50 registros por consulta, ordenado por started_at DESC)

Cada objeto no array segue a mesma estrutura descrita em Consultar por ID. Valores monetários em unidades base (÷ 10.000 para reais).

Limite e paginação

O endpoint retorna no máximo 50 resultados por consulta, ordenados do mais recente ao mais antigo (started_at DESC). Não há parâmetros de paginação -- se precisar de mais resultados, combine a tag com um filtro de data mais estreito (ex: PIXIN20260307 para o dia específico) ou utilize Consultar por E2E para entradas individuais.

Resposta de Sucesso -- Sem Resultados (200)

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

Resposta de Erro (401)

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

Cash-In e Cash-Out

Este endpoint retorna tanto transações de entrada quanto de saída que correspondam à tag. Filtre pelo prefixo PIXIN para obter apenas recebimentos ou PIXOUT para apenas envios.