Aprobar Cash Out

Aprueba una transferencia PIX previamente creada. Utilizado en el flujo de dos etapas (crear + aprobar), donde la transferencia aguarda aprobacion explicita antes de ser enviada al SPI.

Endpoint

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

Headers

Header	Tipo	Obligatorio	Descripcion
Authorization	String	Si	ApiKey {client_id}:{client_secret}
Content-Type	String	Si	application/json
hmac	String	Si	Firma HMAC-SHA512 del body (hex)

Request Body

Campo	Tipo	Obligatorio	Descripcion
transaction_id	String	Si	ID de la transaccion devuelto en la creacion del cash-out

Flujo de aprobacion

Este endpoint debe ser llamado unicamente para transacciones que se encuentren con estado pending_approval. Las transacciones que ya fueron aprobadas o procesadas retornan error.

Ejemplo

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"
  }'

Respuesta Exitosa -- 200

{
  "worked": true,
  "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
  "status": "processing",
  "detail": "Transacao aprovada e enviada para processamento"
}

Campo	Tipo	Descripcion
worked	Boolean	true indica que la aprobacion fue aceptada
transaction_id	String	Identificador de la transaccion aprobada
status	String	Nuevo estado: processing
detail	String	Mensaje descriptivo

Respuesta de Error -- 404

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

Respuesta de Error -- 422

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

Flujo Crear + Aprobar

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

Cuando usar el flujo de aprobacion

El flujo de dos etapas permite validar la transaccion internamente (por ejemplo, con reglas de compliance o limites) antes de autorizar el envio al SPI. Si su operacion no requiere aprobacion manual, el cash-out por clave o EMV ya envia directamente para procesamiento.