全額返金

全額返金Server-side

put/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund

ユーザーに支払いを返却するための返金リクエストを送信します。処理の詳細については、返金機能をお読みください。

メモ

このAPIメソッドはサンドボックスモードで呼び出すことができます。そのためには、リクエストの中でテスト用の決済データを渡します。サンドボックスモードのアクセス方法とテストシナリオの詳細については、説明を参照してください。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer マーチャントID。
transaction_id required	integer トランザクションID。

Request Body schema: application/json

description required	string <= 4000 characters 返金の理由。
email	string <= 100 characters ユーザーのEメール。

Responses

200

OK（エラーなし）。

204

返金リクエストを受け付けました。

401

Unauthorized（アクセスが拒否された）。

404

取引が見つかりません。

422

Unprocessable Entity（無効なリクエストパラメータ）。

Request samples

application/json

{"description": "test refund request"
}

Response samples

application/json

{"message": "The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds."
}