Consulter Cash Out par Tag

Consulte les transactions PIX correspondant a un tag (prefixe du transaction_id). Permet de regrouper et rechercher des transactions par date, type ou tout prefixe de l'identifiant.

Endpoint

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

En-tetes

En-tete	Type	Obligatoire	Description
Authorization	String	Oui	ApiKey {client_id}:{client_secret}

Path Parameters

Parametre	Type	Obligatoire	Description
tag	String	Oui	Prefixe du transaction_id pour la recherche

Exemples de recherche par tag

• PIXOUT20260309 -- tous les virements PIX sortants du 09/03/2026
• PIXOUT -- tous les virements PIX sortants
• PIXIN20260309 -- tous les encaissements PIX du 09/03/2026

Exemple

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

Reponse de Succes -- 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
    }
  ]
}

Champ	Type	Description
data	Array	Liste des transactions correspondant au prefixe

Chaque objet du tableau suit la meme structure de la consultation par ID. Valeurs monetaires en unites de base (/ 10 000 pour reais).

Limite de resultats

La recherche par tag retourne au maximum 50 transactions par requete. Utilisez des prefixes plus specifiques (ex : date complete) pour affiner les resultats.

Reponse Vide -- 200

Lorsqu'aucune transaction ne correspond au prefixe indique :

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