PIX Cash In -- Generer un QR Code

Genere une demande de paiement PIX avec QR Code pour recevoir des fonds sur le compte associe a votre API Key.

Endpoint

POST /api/v2/external/pix/cash-in

En-tetes

En-tete	Type	Obligatoire	Description
Authorization	String	Oui	Bearer {access_token}
Content-Type	String	Oui	application/json
hmac	String	Oui	Signature HMAC-SHA512 du body (en savoir plus)

Request Body

Champ	Type	Obligatoire	Description	Exemple
amount	Integer	Oui	Montant en centimes	10000 (R$ 100,00)
description	String	Non	Description de la demande de paiement (max 140 caracteres)	"Commande #1234"

Valeurs en centimes

Toutes les valeurs monetaires sont des entiers en centimes. R$ 100,00 = 10000. Divisez par 100 pour obtenir la valeur en reais.

Exemple

BODY='{"amount":10000,"description":"Commande #1234"}'
HMAC=$(echo -n "$BODY" | openssl dgst -sha512 -hmac "$CLIENT_SECRET" | awk '{print $2}')

curl -X POST https://api.owem.com.br/api/v2/external/pix/cash-in \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d "$BODY"

Reponse de Succes (200)

{
  "worked": true,
  "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
  "end_to_end_id": "E37839059202603071530000001",
  "qr_code": "00020126580014br.gov.bcb.pix...",
  "qr_code_image": "data:image/png;base64,iVBORw0KGgo...",
  "amount": 10000,
  "status": "pending"
}

Champ	Type	Description
worked	Boolean	true indique le succes de l'operation
transaction_id	String	Identifiant unique de la transaction
end_to_end_id	String	ID de bout en bout du BACEN (E2E)
qr_code	String	Code EMV copier-coller pour paiement
qr_code_image	String	Image du QR Code encodee en base64 (PNG)
amount	Integer	Montant de la demande de paiement en centimes
status	String	Statut initial : pending (en attente de paiement)

Reponse d'Erreur (400)

{
  "worked": false,
  "detail": "Le champ amount est obligatoire"
}

Reponse d'Erreur (401)

{
  "worked": false,
  "detail": "Token invalide ou expire"
}

Reponse d'Erreur (422)

{
  "worked": false,
  "detail": "HMAC invalide"
}

Flux Recommande

1. Generez la demande de paiement avec cet endpoint
2. Affichez le QR Code (qr_code_image) ou le code copier-coller (qr_code) au payeur
3. Recevez la confirmation via Webhook lorsque le paiement est effectue
4. Ou consultez le statut : par ID, par E2E, par Tag

Validite du QR Code

Le QR Code genere a une validite de 24 heures. Passe ce delai, la demande de paiement expire automatiquement et le statut passe a cancelled.