Consulter Cash-In par Tag

Consultez les transactions PIX qui correspondent à une tag (préfixe du transaction_id).

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	Définissez à camelCase pour recevoir les champs de la réponse en camelCase (par défaut snake_case)

Path Parameters

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

Préfixes de Tag

Les transaction_id suivent le pattern PIXIN (réceptions) et PIXOUT (envois) suivi de la date. Utilisez PIXIN20260307 pour rechercher toutes les réceptions 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"

Réponse de succès (200)

{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d",
      "transaction_id": "7popu57v6us7p6pcicgq12345",
      "end_to_end_id": "E37839059202603071530000001",
      "external_id": "order-9876",
      "type": "pix",
      "status": "settled",
      "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": "f7e8d9c0b1a24c3d9e8f7a6b5c4d3e2f",
      "transaction_id": "7popu57v6us7p6pcicgq67890",
      "end_to_end_id": "E37839059202603071545000002",
      "external_id": null,
      "type": "pix",
      "status": "settled",
      "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 succès de l'opération
data	Array	Liste des transactions qui correspondent à la tag (limite fixe de 50 enregistrements par consultation, triée par started_at DESC)

Chaque objet dans le tableau suit la même structure décrite dans Consulter par ID. Valeurs monétaires en unités de base (÷ 10 000 pour reais).

Limite et pagination

L'endpoint retourne un maximum de 50 résultats par consultation, triés du plus récent au plus ancien (started_at DESC). Il n'y a pas de paramètres de pagination -- si vous avez besoin de plus de résultats, combinez la tag avec un filtre de date plus étroit (ex. : PIXIN20260307 pour le jour spécifique) ou utilisez Consulter par E2E pour des entrées individuelles.

Réponse de succès -- sans résultats (200)

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

Réponse 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 d'entrée que de sortie qui correspondent à la tag. Filtrez par le préfixe PIXIN pour obtenir uniquement les réceptions ou PIXOUT pour uniquement les envois.