PIX Cash Out par Cle

Effectue un virement PIX en utilisant la cle PIX du destinataire.

Endpoint

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

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 (hex)

Authentification

Obtenez le access_token via Auth Token. La signature HMAC doit etre generee conformement aux instructions de HMAC-SHA512.

Request Body

Champ	Type	Obligatoire	Description
amount	Integer	Oui	Montant en centimes. R$ 100,00 = 10000
pix_key	String	Oui	Cle PIX du destinataire
pix_key_type	String	Oui	Type de cle : cpf, cnpj, email, phone, evp
description	String	Non	Description du virement (max. 140 caracteres)

Valeurs en centimes

Toutes les valeurs monetaires de l'API sont representees en centimes (entier). Pour envoyer R$ 1.500,75, indiquez 150075.

Exemple

curl -X POST https://api.owem.com.br/api/v2/external/pix/cash-out \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d '{
    "amount": 10000,
    "pix_key": "12345678901",
    "pix_key_type": "cpf",
    "description": "Paiement fournisseur"
  }'

Reponse de Succes -- 200

{
  "worked": true,
  "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
  "end_to_end_id": "E37839059202603091530abcdef01",
  "amount": 10000,
  "fee": 0,
  "status": "processing",
  "detail": "PIX envoye pour traitement"
}

Champ	Type	Description
worked	Boolean	true indique que la requete a ete acceptee
transaction_id	String	Identifiant unique de la transaction
end_to_end_id	String	Identifiant End-to-End dans le SPI/BACEN (format E{ISPB}...)
amount	Integer	Montant du virement en centimes
fee	Integer	Frais debites en centimes
status	String	Statut initial : processing
detail	String	Message descriptif

Reponse d'Erreur -- 400

{
  "worked": false,
  "detail": "Cle PIX invalide"
}

Reponse d'Erreur -- 422

{
  "worked": false,
  "detail": "Solde insuffisant"
}

Types de Cle PIX

Type	Format	Exemple
cpf	11 chiffres (sans ponctuation)	12345678901
cnpj	14 chiffres (sans ponctuation)	12345678000199
email	Adresse e-mail	nom@entreprise.com.br
phone	+55 + indicatif regional + numero	+5511999998888
evp	UUID v4	a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Etapes Suivantes

Apres avoir cree le virement, suivez le statut via :

• Consulter par ID
• Consulter par E2E ID
• Consulter par Tag

Ou recevez la confirmation automatiquement via Webhook.