Skip to content

Consultar Cash In por Tag

Consulta transacoes PIX que correspondem a uma tag (prefixo do transaction_id).

Endpoint

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

Headers

HeaderTipoObrigatorioDescricao
AuthorizationStringSimBearer {access_token}

Path Parameters

ParametroTipoObrigatorioDescricao
tagStringSimPrefixo do transaction_id para busca

Prefixos de Tag

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

Exemplo

bash
curl -X GET https://api.owem.com.br/api/v2/external/transactions/tag/PIXIN20260307 \
  -H "Authorization: Bearer $TOKEN"

Resposta de Sucesso (200)

json
{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603071530000001",
      "type": "pix",
      "status": "completed",
      "amount": 10000,
      "fee_amount": 0,
      "net_amount": 10000,
      "direction": "inbound",
      "counterparty_name": "Maria Santos",
      "created_at": "2026-03-07T15:30:00Z",
      "completed_at": "2026-03-07T15:30:02Z"
    },
    {
      "id": "f7e8d9c0-b1a2-4c3d-9e8f-7a6b5c4d3e2f",
      "transaction_id": "PIXIN20260307x9y8z7w6v5u4",
      "end_to_end_id": "E37839059202603071545000002",
      "type": "pix",
      "status": "completed",
      "amount": 25000,
      "fee_amount": 0,
      "net_amount": 25000,
      "direction": "inbound",
      "counterparty_name": "Joao Silva",
      "created_at": "2026-03-07T15:45:00Z",
      "completed_at": "2026-03-07T15:45:03Z"
    }
  ]
}
CampoTipoDescricao
workedBooleantrue indica sucesso na operacao
dataArrayLista de transacoes que correspondem a tag

Cada objeto no array segue a mesma estrutura descrita em Consultar por ID.

Resposta de Sucesso -- Sem Resultados (200)

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

Resposta de Erro (401)

json
{
  "worked": false,
  "detail": "Token invalido ou expirado"
}

Cash In e Cash Out

Este endpoint retorna tanto transacoes de entrada quanto de saida que correspondam a tag. Filtre pelo prefixo PIXIN para obter apenas recebimentos ou PIXOUT para apenas envios.

Owem Pay Instituição de Pagamento — ISPB 37839059