Order Summaries, Ensure Refunds Async

ルート XML タグ

<ensureRefundsAsyncInput>

JSON の例

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
creditMemoId	String	返金額を表すクレジットメモの ID。	creditMemoId または excessFunds​Amount のいずれかが必要	48.0
excessFunds​Amount	Double	返金する超過資金の金額。	excessFunds​Amount または 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

• HTTP 状況コードで成功が示された場合、レスポンスボディは、Ensure Refunds Async Output です。それでもこのレスポンスボディが処理エラーを示す場合があります。
• HTTP 状況コードが 400 (クライアントエラー) または 500 (サーバエラー) の範囲内にある場合、レスポンスボディは、Error with Output です。output プロパティは Ensure Refunds Async Output です。enhancedErrorType プロパティの値は無視できます。

次の方法により、このロジックに従って指定された OrderSummary に関連付けられた OrderPaymentSummaries に返金が適用されます。

1. CreditMemo の残高と超過資金の金額が、OrderSummary に関連付けられているすべての OrderPaymentSummaries の AvailableToRefund の合計金額を超えていないことを確認します。
2. sequences が指定されている場合は、次の手順を実行します。
   1. sequences リストを順番にトラバースし、指定の返金額を指定の OrderPaymentSummaries に適用します。
   2. 指定された CreditMemo および超過資金が完全に返金された場合、または isAllowPartial が true の場合は、ここでアクションが停止します。
3. CreditMemo が指定された場合は、次の手順に従います。
   1. OrderPaymentSummary の AvailableToRefund の金額が CreditMemo の残高に一致する場合は、その支払いに返金を適用します。
   2. 完全に一致するものがない場合は、AvailableToRefund の金額が最大の OrderPaymentSummary に返金を適用します。
   3. CreditMemo に残高がある場合は、その残高が完全に返金されるまで手順 a と b を繰り返します。
4. 超過資金の金額が指定されている場合は、次の手順に従います。
   1. 該当する OrderPaymentSummaries を確認します。超過資金の金額と一致する金額の AvailableToRefund があれば、その OrderPaymentSummary に返金を適用します。
   2. 完全に一致するものがない場合は、AvailableToRefund の金額が最大の OrderPaymentSummary に返金を適用します。
   3. 超過資金が残っている場合は、完全に返金されるまでステップ a および b を繰り返します。