この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Payment, Create Refund

支払の返金を作成します。

Salesforce Payments リソースにアクセスするには、次の権限が必要です。

Salesforce Order Management ライセンス
PaymentsAPIUser ユーザー権限。この権限は、Salesforce Order Management ライセンスで使用できます。Salesforce システム管理者はこれをユーザープロファイルに割り当てます。

リソース

1/commerce/payments/payments/paymentId/refunds

paymentId パラメーターは、支払レコードを表します。

使用可能なバージョン

48.0

HTTP のメソッド

POST

POST のリクエストボディ

JSON のみをサポートします。XML はサポートされていません。

メモ

JSON の例 (羃等なし)

1{
2  "accountId":"",
3  "amount": 150,
4  "comments": "refund request",
5  "paymentGroup":{
6      "createPaymentGroup":"true",
7      "sourceObjectId":"",
8      "currencyIsoCode":"USD"
9  },
10  "effectiveDate":"2019-10-18T11:32:27.000Z",
11  "ipAddress": "202.95.77.70",
12  "macAddress": "00-14-22-01-23-45",
13  "phone": "100-456-67",
14  "email": "test@ccs.org",
15  "additionalData":{
16      "key1":"value1",
17      "key2":"value2",
18      "key3":"value3",
19      "key4":"value4",
20      "key5":"value5"
21    }
22}

JSON の例 (JSON ペイロード内に羃等キー)

1{
2  "accountId":"",
3  "amount": 150,
4  "idempotencyKey":"UniqueIdempotencyKey",
5  "comments": "capture request",
6  "paymentGroup":{
7      "createPaymentGroup":"true",
8      "sourceObjectId":"",
9      "currencyIsoCode":"USD"
10  },
11  "effectiveDate":"2019-10-18T11:32:27.000Z",
12  "ipAddress": "202.95.77.70",
13  "macAddress": "00-14-22-01-23-45",
14  "phone": "100-456-67",
15  "email": "test@ccs.org",
16  "additionalData":{
17      "key1":"value1",
18      "key2":"value2",
19      "key3":"value3",
20      "key4":"value4",
21      "key5":"value5"
22    }
23}

JSON の例 (ヘッダー内に羃等キー)

1{
2  "accountId":"",
3  "amount": 150,
4  "comments": "capture request",
5  "paymentGroup":{
6      "createPaymentGroup":"true",
7      "sourceObjectId":"",
8      "currencyIsoCode":"USD"
9  },
10  "effectiveDate":"2019-10-18T11:32:27.000Z",
11  "ipAddress": "202.95.77.70",
12  "macAddress": "00-14-22-01-23-45",
13  "phone": "100-456-67",
14  "email": "test@ccs.org",
15  "additionalData":{
16      "key1":"value1",
17      "key2":"value2",
18      "key3":"value3",
19      "key4":"value4",
20      "key5":"value5"
21    }
22}

ヘッダー

名前: sfdc-Payments-Idempotency-Key

データ型: 文字列

最大長: 255

例:

1Content-Type: application/json; charset=UTF-8
2Accept: application/json
3sfdc-Payments-Idempotency-Key: UniqueIdempotencyKey

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`accountId`	String	この参照される返金要求にリンクする必要がある取引先の ID。	省略可能	48.0
`additionalData`	Map<String, String>	支払要求が必要な場合は、追加のデータを入力できます。additionalData オブジェクトは、エントリから構成されます。各エントリには、キーと値が含まれます。サポートされるキーと値のペアは、最大 5 つです。それぞれのキーと値には、255 文字まで入力できます。	省略可能	48.0
`amount`	Double	返金する必要がある金額。	必須	48.0
`clientContext`	String	支払 API のコンテキストを提供します。コンテキストを再確立するために支払のコール元で使用されます。	省略可能	49.0
`comments`	String	返金に関するコメント。	省略可能	48.0
`effectiveDate`	String	返金が有効になる日付。	省略可能	48.0
`email`	String	要求を開始したクライアントのメール。	省略可能	48.0
`idempotencyKey`	String	支払要求で使用される羃等キー。ペイロードまたはヘッダーに指定できますが、その両方に同時に指定することはできません。	省略可能	48.0
`ipAddress`	String	要求を行ったクライアントの IP アドレス。	省略可能	48.0
`macAddress`	String	要求を行ったクライアントの MAC アドレス。	省略可能	48.0
`paymentGroup`	Payment Group Input	返金要求に関連付けられた支払グループの詳細。	省略可能	48.0
`phone`	String	要求を開始したクライアントの電話番号。	省略可能	48.0

POST のレスポンスボディ

Referenced Refund Service Output

Connect REST API 開発者ガイド

Payment, Create Refund