批准 Cash Out

批准一笔先前创建的 PIX 转账。适用于两步流程（创建 + 批准），转账在发送至 SPI 之前需要明确的批准操作。

接口

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

请求头

请求头	类型	必填	说明
Authorization	String	是	ApiKey {client_id}:{client_secret}
Content-Type	String	是	application/json
hmac	String	是	请求体的 HMAC-SHA512 签名（十六进制）

请求体

字段	类型	必填	说明
transaction_id	String	是	创建 cash-out 时返回的交易 ID

批准流程

此接口仅适用于状态为 pending_approval 的交易。已批准或已处理的交易将返回错误。

示例

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

成功响应 -- 200

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

字段	类型	说明
worked	Boolean	true 表示批准已被接受
transaction_id	String	已批准的交易标识符
status	String	新状态：processing
detail	String	描述信息

错误响应 -- 404

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

错误响应 -- 422

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

创建 + 批准流程

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

何时使用批准流程

两步流程允许您在授权发送至 SPI 之前进行内部验证（例如合规规则或限额检查）。如果您的业务不需要手动批准，通过密钥或 EMV 发起的 cash-out 将直接进入处理流程。