Consulter Cash-Out par Tag

Consultez les transactions PIX qui correspondent à une tag (préfixe du transaction_id). Permet de grouper et rechercher des transactions par date, type ou tout préfixe de l'identifiant.

Endpoint

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

Headers

Header	Type	Obligatoire	Description
Authorization	String	Oui	ApiKey {client_id}:{client_secret}
X-Key-Case	String	Non	Envoyez camelCase pour recevoir la réponse avec clés en camelCase (ex. : transactionId, endToEndId, payerIspb). Sans cet en-tête, la réponse reste en snake_case conforme à l'exemple ci-dessous. Appliqué par FluxiqWeb.Plugs.KeyCase — voir Authentification

Path Parameters

Paramètre	Type	Obligatoire	Description
tag	String	Oui	Préfixe du transaction_id pour la recherche

Exemples de recherche par tag

• PIXOUT20260309 -- tous les virements PIX de sortie du jour 09/03/2026
• PIXOUT -- tous les virements PIX de sortie
• PIXIN20260309 -- toutes les réceptions PIX du jour 09/03/2026

Exemple

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

Réponse de succès -- 200

{
  "worked": true,
  "data": [
    {
      "id": "c7f3a8b12d4e4f6a9c1b3e5f7a9b1d3e",
      "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603091530abcdef01",
      "external_id": "order-9876",
      "type": "pix",
      "direction": "outbound",
      "status": "settled",
      "amount": 300000,
      "fee_amount": 350,
      "net_amount": 300350,
      "description": "Paiement fournisseur",
      "counterparty_name": "Joao Silva",
      "recipient_key": "12345678901",
      "payer_document": "37839059000188",
      "recipient_document": "12345678901",
      "payer_ispb": "37839059",
      "payer_bank_name": "Owem Pay",
      "created_at": "2026-03-09T15:30:00Z",
      "completed_at": "2026-03-09T15:30:02Z"
    },
    {
      "id": "d8e4b9c23f5a5b7c0d2e4f6a8b0c2e4f",
      "transaction_id": "PIXOUT20260309f6e5d4c3b2a1",
      "end_to_end_id": "E37839059202603091545abcdef02",
      "external_id": null,
      "type": "pix",
      "direction": "outbound",
      "status": "settled",
      "amount": 2500000,
      "fee_amount": 350,
      "net_amount": 2500350,
      "description": "Paiement service",
      "counterparty_name": "Maria Santos",
      "recipient_key": "98765432100",
      "payer_document": "37839059000188",
      "recipient_document": "98765432100",
      "payer_ispb": "37839059",
      "payer_bank_name": "Owem Pay",
      "created_at": "2026-03-09T15:45:00Z",
      "completed_at": "2026-03-09T15:45:01Z"
    }
  ]
}

Champ	Type	Description
data	Array	Liste des transactions qui correspondent au préfixe. Peut arriver vide ([]) quand rien ne correspond — malgré tout HTTP 200

Portée de la recherche

La recherche par tag consulte uniquement la table transactions (transactions liquidées/rejetées). Les PIX OUT en cours (outbound_requests, stage 1–2) et les QR Codes non payés (qrcodes) n'apparaissent pas dans ce listing. Utilisez GET /transactions/:id ou le webhook pix.payout.confirmed pour suivre les transactions en cours.

Chaque objet dans le tableau suit le même shape que la réponse « transaction liquidée » dans GET /transactions/:id. Valeurs monétaires en unités de base (÷ 10 000 pour reais). Les champs payer_document, recipient_document, payer_ispb et payer_bank_name viennent du metadata de la transaction et peuvent être null dans les rows anciennes. Pour les transactions rejetées, la réponse inclut reason_code et reason_description (en anglais).

Limite de résultats

La recherche par tag retourne un maximum de 50 transactions par requête, triées par started_at desc (plus récentes en premier). Il n'y a pas de pagination — utilisez des préfixes plus spécifiques (ex. : PIXOUT20260309 pour un jour entier, ou PIXOUT2026030915 pour une période horaire) pour affiner.

Réponse vide -- 200

Quand aucune transaction ne correspond au préfixe indiqué :

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