Order Summaries, Ensure Refunds Async

ルート XML タグ

<ensureRefundsAsyncInput>

JSON の例

1{
2  "creditMemoId": "50gR000000000JNIAY"
3}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
creditMemoId	String	返金額を表すクレジットメモの ID。	省略可能。ただし少なくとも 1 つの入力プロパティが必要です。	48.0
excessFundsAmount	Double	返金する超過資金の金額。	省略可能。ただし少なくとも 1 つの入力プロパティが必要です。	49.0

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

このメソッドは、指定された OrderSummary に関連する OrderPaymentSummaries で返金金額についてチェックします。このチェックは次のロジックに従って行われます。

1. クレジットメモが指定されている場合は、補足された金額が対応する請求書に充当された OrderPaymentSummaries を特定します。
   1. 該当する OrderPaymentSummaries を確認します。クレジットメモの金額と一致する補足された金額があれば、返金をその支払いに充当します。
   2. 完全に一致するものがない場合は、補足された金額がクレジットメモの金額よりも大きいものを探します。該当するものがある場合は、返金を最小の補足された金額に充当します。
   3. クレジットメモの金額を超える補足された金額がない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。返金がなくなるまでそれらに充当します。
2. 余剰資金の金額が指定されている場合は、補足された金額が請求書に充当されていない OrderPaymentSummaries を特定します。
   1. 該当する OrderPaymentSummaries を確認します。余剰資金の金額と一致する補足された金額があれば、その支払いに返金を充当します。
   2. 完全に一致するものがない場合は、余剰資金の金額よりも大きな補足された金額を探します。該当するものがある場合は、返金を最小の補足された金額に充当します。
   3. クレジットメモの金額を超える補足された金額がない場合は、補足された金額の大きい順に OrderPaymentSummaries を選択していきます。返金がなくなるまでそれらに充当します。