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