Consulter Cash In par Tag

Consulte les transactions PIX correspondant a un tag (prefixe du transaction_id).

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

Prefixes de Tag

Les transaction_id suivent le format PIXIN (encaissements) et PIXOUT (envois) suivi de la date. Utilisez PIXIN20260307 pour rechercher tous les encaissements du 07/03/2026.

Exemple

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

Reponse de Succes (200)

{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "transaction_id": "7popu57v6us7p6pcicgq12345",
      "end_to_end_id": "E37839059202603071530000001",
      "external_id": "order-9876",
      "type": "pix",
      "status": "completed",
      "amount": 300000,
      "fee_amount": 0,
      "net_amount": 300000,
      "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": "7popu57v6us7p6pcicgq67890",
      "end_to_end_id": "E37839059202603071545000002",
      "external_id": null,
      "type": "pix",
      "status": "completed",
      "amount": 2500000,
      "fee_amount": 0,
      "net_amount": 2500000,
      "direction": "inbound",
      "counterparty_name": "Joao Silva",
      "created_at": "2026-03-07T15:45:00Z",
      "completed_at": "2026-03-07T15:45:03Z"
    }
  ]
}

Champ	Type	Description
worked	Boolean	true indique le succes de l'operation
data	Array	Liste des transactions correspondant au tag

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

Reponse de Succes -- Sans Resultats (200)

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

Reponse d'Erreur (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

Cash In et Cash Out

Cet endpoint retourne aussi bien les transactions entrantes que sortantes correspondant au tag. Filtrez par le prefixe PIXIN pour obtenir uniquement les encaissements ou PIXOUT pour uniquement les envois.