Skip to content

Consultar Cash Out por Tag

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

Endpoint

GET /api/v2/external/transactions/tag/{tag}

Headers

HeaderTipoObrigatórioDescrição
AuthorizationStringSimBearer {access_token}

Path Parameters

ParâmetroTipoObrigatórioDescrição
tagStringSimPrefixo do transaction_id para busca

Exemplos de busca por tag

  • PIXOUT20260309 — todas as transferências PIX de saída do dia 09/03/2026
  • PIXOUT — todas as transferências PIX de saída
  • PIXIN20260309 — todos os recebimentos PIX do dia 09/03/2026

Exemplo

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

Resposta de Sucesso — 200

json
{
  "worked": true,
  "data": [
    {
      "id": "c7f3a8b1-2d4e-4f6a-9c1b-3e5f7a9b1d3e",
      "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603091530abcdef01",
      "type": "pix",
      "direction": "outbound",
      "status": "completed",
      "amount": 10000,
      "fee": 0,
      "description": "Pagamento fornecedor",
      "created_at": "2026-03-09T15:30:00Z",
      "updated_at": "2026-03-09T15:30:02Z"
    },
    {
      "id": "d8e4b9c2-3f5a-5b7c-0d2e-4f6a8b0c2e4f",
      "transaction_id": "PIXOUT20260309f6e5d4c3b2a1",
      "end_to_end_id": "E37839059202603091545abcdef02",
      "type": "pix",
      "direction": "outbound",
      "status": "processing",
      "amount": 25000,
      "fee": 0,
      "description": "Pagamento servico",
      "created_at": "2026-03-09T15:45:00Z",
      "updated_at": "2026-03-09T15:45:00Z"
    }
  ]
}
CampoTipoDescrição
dataArrayLista de transações que correspondem ao prefixo

Cada objeto no array segue a mesma estrutura da consulta por ID.

Limite de resultados

A busca por tag retorna no máximo 50 transações por requisição. Utilize prefixos mais específicos (ex: data completa) para refinar os resultados.

Resposta Vazia — 200

Quando nenhuma transação corresponde ao prefixo informado:

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

Owem Pay Instituição de Pagamento — ISPB 37839059