退款

为指定发票创建退款。创建请求时，可以通过 fee_mode 参数指定退款手续费的计算模式。

URL

需要授权

POST

https://api.fps.pro/invoices/refund/{id}

请求格式application/json

fee_mode

number

手续费扣除模式。如果指定 deduct，手续费将从支付金额中扣除，客户收到扣除手续费后的发票金额。如果指定 add，则由您从商户账户支付退款手续费，客户收到完整支付金额。

默认值: deduct

请求示例

curl --request POST 'https://api.fps.pro/invoices/refund/0a718b02-138d-495a-9661-39ca52139c07' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Timestamp: 1720000000' \
  --header 'X-Signature: YOUR_HMAC_SHA256_SIGNATURE' \
  --data '{
  "fee_mode": "deduct"
}'

成功响应

{
  "status": 200,
  "message": "success refund"
}

错误

详细的授权错误列表位于 授权 - 错误

{
  "status": 400,
  "message": "There is no balance available for refund"
}
{
  "status": 404,
  "message": "The invoice is not found"
}
{
  "status": 422,
  "message": "Validation Error",
  "errors": [
    {
      "field": "fee_mode",
      "message": "invalid value"
    }
  ]
}
{
  "status": 500,
  "message": "Internal Server Error"
}