Ensure Refunds Async Input
返金を確認するためのクレジットメモの ID、返金する超過資金の金額、またはこれら両方。少なくとも 1 つは必須項目です。返品手数料など、返金額を減少させる手数料の請求書も含まれます。複数の支払方法が使用可能な場合は、返金の配分方法を指定できます。
- ルート XML タグ
- <ensureRefundsAsyncInput>
- JSON の例
-
1{ 2 "creditMemoId": "50gR000000000JB00G", 3 "invoicesToPay": [ 4 { 5 .."invoiceId": "3ttR000000000JNIAY" 6 } 7] 8} - プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン creditMemoId String 返金額を表すクレジットメモの ID。 creditMemoId または excessFundsAmount のいずれかが必要 48.0 excessFundsAmount Double 返金する超過資金の金額。 excessFundsAmount または creditMemoId のいずれかが必要 49.0 invoicesToPay Invoice To Pay Input[] 返品手数料など、返金を減少させる手数料の請求書のリスト。 省略可能 56.0 isAllowPartial Boolean この値は、sequences リストに含まれている金額が全返金額をカバーしないときの動作を制御します。この値が false の場合は、デフォルトの返金ロジックが適用され、残りの返金額が保証されます。この値が true の場合は、クレジットメモに未返金残高が残ります。sequences リストを指定しない場合は、この値が無視され、デフォルトの返金ロジックが適用されます。デフォルト値は、false です。 省略可能 56.0 sequences Sequence Order Payment Summary Input[] 返金額の順序付きリストとその適用先の OrderPaymentSummaries。この処理は、このリストを順番にトラバースし、全額が返金された時点で停止します。 省略可能 56.0