Consultar Cash Out por Tag

Consulta transacoes PIX que correspondem a uma tag (prefixo do transaction_id). Permite agrupar e buscar transacoes por data, tipo ou qualquer prefixo do identificador.

Endpoint

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

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	ApiKey {client_id}:{client_secret}

Path Parameters

Parametro	Tipo	Obrigatorio	Descricao
tag	String	Sim	Prefixo do transaction_id para busca

Exemplos de busca por tag

• PIXOUT20260309 -- todas as transferencias PIX de saida do dia 09/03/2026
• PIXOUT -- todas as transferencias PIX de saida
• PIXIN20260309 -- todos os recebimentos PIX do dia 09/03/2026

Exemplo

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

Resposta de Sucesso -- 200

{
  "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"
    },
    {
      "id": "d8e4b9c2-3f5a-5b7c-0d2e-4f6a8b0c2e4f",
      "transaction_id": "PIXOUT20260309f6e5d4c3b2a1",
      "end_to_end_id": "E37839059202603091545abcdef02",
      "external_id": null,
      "type": "pix",
      "direction": "outbound",
      "status": "processing",
      "amount": 2500000,
      "fee_amount": 350,
      "net_amount": 2500350,
      "description": "Pagamento servico",
      "counterparty_name": "Maria Santos",
      "recipient_key": "98765432100",
      "created_at": "2026-03-09T15:45:00Z",
      "completed_at": null
    }
  ]
}

Campo	Tipo	Descricao
data	Array	Lista de transacoes que correspondem ao prefixo

Cada objeto no array segue a mesma estrutura da consulta por ID. Valores monetarios em unidades base (÷ 10.000 para reais).

Limite de resultados

A busca por tag retorna no maximo 50 transacoes por requisicao. Utilize prefixos mais especificos (ex: data completa) para refinar os resultados.

Resposta Vazia -- 200

Quando nenhuma transacao corresponde ao prefixo informado:

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