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 を選択します。
- 選択した資金が承認された場合は、資金を捕捉します。
- 選択した資金を請求書に適用します。