Consulter Cash-In par E2E ID

Consultez une transaction PIX par son End-to-End ID (identifiant unique du BACEN).

Endpoint

GET /api/external/transactions/e2e/:e2e_id

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
e2e_id	String	Oui	End-to-End ID de la transaction (format BACEN, regex ^E\d{8}[a-zA-Z0-9]{22,26}$)

Format du E2E ID (BACEN)

L'E2E ID suit le standard BACEN : E + ISPB (8 chiffres numériques) + timestamp UTC (13 chiffres numériques) + identifiant alphanumérique (9-13 caractères, peut contenir lettres et chiffres).

Exemples valides :

• E37839059202603071530000001 -- entièrement numérique (généré par des systèmes qui n'utilisent que des chiffres)
• E18236120202604221900s1218936740 -- contient des lettres (généré par Nubank, ISPB 18236120)
• E60746948202604091234A2004l6Agm0 -- alphanumérique typique (majuscules et minuscules sont valides)

Attention : ne supposez jamais que l'E2E est entièrement numérique -- les banques émettrices peuvent utiliser des lettres. Votre intégration doit accepter la regex ^E\d{8}[a-zA-Z0-9]{22,26}$.

Exemple

curl -X GET https://api.owem.com.br/api/external/transactions/e2e/E37839059202603071530000001 \
  -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,
    "description": "Commande #1234",
    "direction": "inbound",
    "counterparty_name": "Maria Santos",
    "payer_document": "12345678901",
    "recipient_document": "37839059000188",
    "recipient_key": "contato@empresa.com.br",
    "payer_ispb": "60701190",
    "payer_bank_name": "ITAU UNIBANCO S.A.",
    "created_at": "2026-03-07T15:30:00Z",
    "completed_at": "2026-03-07T15:30:02Z"
  }
}

Cet endpoint retourne le même objet de transaction décrit dans Consulter par ID -- y compris les formes alternatives processing (PIX OUT en vol, avec objet recipient imbriqué) et failed (avec reason_code + reason_description). Toutes les valeurs monétaires sont en unités de base (÷ 10 000 pour reais).

Réponse d'erreur (404)

{
  "worked": false,
  "detail": "Transação não encontrada para o E2E informado"
}

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. Utilisez le champ direction pour différencier : inbound (réception) ou outbound (envoi).