退款
post
https://api.cryptomus.com/v1/payment/refund
要求
查詢參數
| 姓名 | 參數類型 | 定義 |
|---|---|---|
| address* | string | 退款地址 |
| is_subtract* | boolean | 是否從商家餘額或退款金額中收取佣金true - 從商家餘額中扣除佣金false - 將可退款金額減少佣金金額 |
| uuid* | uuidrequired_without: order_id | 發票 UUID |
| order_id* | stringmin:1max:128alpha_dashrequired_without: uuid | 發票訂單ID |
參數類型
string定義
退款地址參數類型
boolean定義
是否從商家餘額或退款金額中收取佣金true - 從商家餘額中扣除佣金false - 將可退款金額減少佣金金額參數類型
uuidrequired_without: order_id定義
發票 UUID參數類型
stringmin:1max:128alpha_dashrequired_without: uuid定義
發票訂單ID
* - 必需參數
發票由 order_id 或者 uuid，如果同時傳遞這兩個參數，則帳戶將透過 uuid 進行識別
請求範例
curl https://api.cryptomus.com/v1/payment/refund \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "8b03432e-385b-4670-8d06-064591096795",
"address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm",
"is_subtract": "true"
}'回覆
回應範例
1{
2 "state": 0,
3 "result": []
4}可能的錯誤
驗證錯誤
程式碼 : 422
範例回覆：
如果您提供的 uuid 或 order_id 對應的發票不存在：
1{
2 "state": 1,
3 "message": "Payment was not found"
4} 如果您不傳遞 uuid 和 order_id，您將收到此訊息。這意味著至少需要一個參數。
1{
2 "state": 1,
3 "errors": {
4 "uuid": ["validation.required_without"],
5 "order_id": ["validation.required_without"]
6 }
7}如果您的商家付款被凍結，您將收到此錯誤訊息。例如，當您更改密碼導致付款凍結 24 小時後，就會發生這種情況。
1{
2 "state": 1,
3 "message": "You are forbidden"
4}
5如果與發票相關的商家錢包不存在：
1{
2 "state": 1,
3 "message": "Undefined merchant wallet"
4}如果發票尚未最終確定或尚未付款。
1{
2 "state": 1,
3 "message": "Refunds are made only for completed payments"
4}如果退款金額超過發票付款金額：
1{
2 "state": 1,
3 "message": "The refund amount should not be more than the amount paid"
4}如果發生技術問題且付款暫時無法使用，您可能會收到此錯誤訊息：
1{
2 "state": 1,
3 "message": "Server error"
4}