返金
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} a uuid および order_id を渡さない場合、このメッセージを受け取ります。これは、少なくとも1つのパラメーターが必要であることを意味します。
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}