Skip to content

Approuver Cash Out

Approuve un transfert PIX prealablement cree. Utilise dans le flux en deux etapes (creer + approuver), ou le transfert attend une approbation explicite avant d'etre envoye au SPI.

Endpoint

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

En-tetes

En-teteTypeObligatoireDescription
AuthorizationStringOuiApiKey {client_id}:{client_secret}
Content-TypeStringOuiapplication/json
hmacStringOuiSignature HMAC-SHA512 du corps de la requete (hex)

Corps de la requete

ChampTypeObligatoireDescription
transaction_idStringOuiID de la transaction retourne lors de la creation du cash-out

Flux d'approbation

Cet endpoint ne doit etre appele que pour les transactions dont le statut est pending_approval. Les transactions deja approuvees ou traitees retournent une erreur.

Exemple

bash
curl -X POST https://api.owem.com.br/api/external/pix/cash-out/approve \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d '{
    "transaction_id": "PIXOUT20260309a1b2c3d4e5f6"
  }'

Reponse de succes -- 200

json
{
  "worked": true,
  "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
  "status": "processing",
  "detail": "Transacao aprovada e enviada para processamento"
}
ChampTypeDescription
workedBooleantrue indique que l'approbation a ete acceptee
transaction_idStringIdentifiant de la transaction approuvee
statusStringNouveau statut : processing
detailStringMessage descriptif

Reponse d'erreur -- 404

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

Reponse d'erreur -- 422

json
{
  "worked": false,
  "detail": "Transacao ja foi processada"
}

Flux Creer + Approuver

1. POST /api/external/pix/cash-out      → status: pending_approval
2. POST /api/external/pix/cash-out/approve → status: processing
3. Webhook ou consultation                   → status: completed / failed

Quand utiliser le flux d'approbation

Le flux en deux etapes permet de valider la transaction en interne (par exemple, avec des regles de conformite ou des limites) avant d'autoriser l'envoi au SPI. Si votre operation ne necessite pas d'approbation manuelle, le cash-out par cle ou EMV envoie directement au traitement.

Owem Pay Instituição de Pagamento — ISPB 37839059