Hoàn tiền

Tạo hoàn tiền cho hóa đơn được chỉ định. Khi tạo yêu cầu, bạn có thể chỉ định chế độ tính phí hoàn tiền bằng tham số fee_mode.

URL

Yêu cầu ủy quyền

POST

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

Định dạng yêu cầuapplication/json

fee_mode

number

Chế độ thu phí. Nếu chỉ định deduct, phí sẽ được trừ khỏi số tiền thanh toán và khách hàng nhận số tiền hóa đơn sau khi trừ phí. Nếu chỉ định add, bạn trả phí hoàn tiền từ tài khoản merchant và khách hàng nhận toàn bộ số tiền thanh toán.

Mặc định: deduct

Ví dụ yêu cầu

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

Phản hồi thành công

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

Lỗi

Danh sách lỗi ủy quyền chi tiết nằm trong Ủy quyền - Lỗi

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