Connect REST API 開発者ガイド
jOrder Summaries, Ensure Funds Async
請求書の資金を確認して適用します。必要に応じて、支払プロバイダーに要求を送信して承認済み資金を捕捉します。この方法によってバックグラウンド操作が非同期ジョブキューに挿入され、その操作の ID が返されるため、ユーザーはその状況を追跡できます。支払ゲートウェイ応答は、支払ゲートウェイログに表示され、バックグラウンド操作状況には影響しません。
- リソース
-
1/commerce/order-management/order-summaries/orderSummaryId/async-actions/ensure-funds-async - 使用可能なバージョン
- 48.0
- HTTP のメソッド
- POST
- POST のリクエストボディ
-
Ensure Funds Async Input
- ルート XML タグ
- <ensureFundsAsyncInput>
- JSON の例
-
1{ 2 "invoiceId": "3ttR000000000JNIAY" 3} - プロパティ
- POST のレスポンスボディ
-
- HTTP 状況コードで成功が示された場合、レスポンスボディは、Ensure Funds Async Output です。それでもこのレスポンスボディが処理エラーを示す場合があります。
- HTTP 状況コードが 400 (クライアントエラー) または 500 (サーバーエラー) の範囲内にある場合、レスポンスボディは、Error with Output です。output プロパティは Ensure Funds Async Output です。enhancedErrorType プロパティの値は無視できます。
- 使用方法
-
このメソッドは、指定された OrderSummary に関連する OrderPaymentSummaries で、請求書残高に充当する資金をチェックします。このチェックは次のロジックに従って行われます。
- 請求書残高が、OrderSummary に関連付けられているすべての OrderPaymentSummaries の合計 BalanceAmount を超えていないことを確認します。
- OrderPaymentSummary の BalanceAmount が請求書残高に等しい場合は、その OrderPaymentSummary から資金を充当します。
- 完全に一致するものが��い場合は、BalanceAmount が最大の OrderPaymentSummary から資金を充当します。
- 請求書に確認すべき残高がまだある場合は、完全な残高が確認されるまで、または捕捉された資金の残りがなくなるまで、ステップ 2 と 3 を繰り返します。
- 請求書にまだ残高がある場合は、請求書残高の残額に等しい承認金額の OrderPaymentSummary を探します。該当するものがある場合は、その OrderPaymentSummary から資金を捕捉して充当します。
- 完全に一致するものがない場合は、承認金額が最大の OrderPaymentSummary から資金を捕捉して充当します。
- 請求書に確認すべき残高がまだある場合は、完全な残高が確認されるまで、ステップ 5 と 6 を繰り返します。