Consulter Cash In par ID

Consulte le statut et les details d'une transaction PIX par l'ID de la transaction.

Endpoint

GET /api/external/transactions/:id

En-tetes

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

Path Parameters

Parametre	Type	Obligatoire	Description
id	String	Oui	ID de la transaction (transaction_id)

Exemple

curl -X GET https://api.owem.com.br/api/external/transactions/7popu57v6us7p6pcicgq12345 \
  -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,
    "description": "Pedido #1234",
    "direction": "inbound",
    "counterparty_name": "Maria Santos",
    "created_at": "2026-03-07T15:30:00Z",
    "completed_at": "2026-03-07T15:30:02Z"
  }
}

Champ	Type	Description
worked	Boolean	true indique le succes de l'operation
data.id	String	UUID interne de la transaction
data.transaction_id	String	Identifiant public de la transaction
data.end_to_end_id	String	ID de bout en bout du BACEN (E2E)
data.external_id	String	Identifiant de votre systeme. null si non renseigne lors de la creation
data.type	String	Type de la transaction (pix)
data.status	String	Statut actuel (voir tableau ci-dessous)
data.amount	Integer	Montant en unites de base (/ 10 000 pour reais). 300000 = R$ 30,00
data.fee_amount	Integer	Montant des frais en unites de base
data.net_amount	Integer	Montant net en unites de base
data.description	String	Description de la transaction
data.direction	String	inbound pour les encaissements
data.counterparty_name	String	Nom du payeur
data.created_at	String	Date de creation (ISO 8601)
data.completed_at	String	Date de conclusion (ISO 8601), null si en attente

Statuts Possibles

Statut	Description
active	QR Code genere, en attente de paiement
pending	Paiement detecte, en cours de traitement
completed	Paiement confirme
failed	Paiement echoue
cancelled	Facturation annulee ou expiree

Reponse d'Erreur (404)

{
  "worked": false,
  "detail": "Transacao nao encontrada"
}

Reponse d'Erreur (401)

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

Polling vs Webhook

Pour suivre le statut d'une facturation, preferez utiliser les Webhooks plutot que le polling. Si vous devez consulter, utilisez des intervalles d'au moins 5 secondes.