柔軟な支払いに支払いラインアイテムを使用する公開プレビュー

マルチキャプチャやオーバーキャプチャなどの 複雑な決済 に支払いラインアイテムを使用できます。

Multicapture

決済項目は、マルチキャプチャー中に使用できます。

未キャプチャーの PaymentIntent を作成して確定する

PaymentIntentの作成時にcapture_methodをmanualとして指定し、if_availableパラメーターを使用してこの決済のマルチキャプチャーをリクエストします。作成される PaymentIntent では、支払い方法がサポートしている場合に、マルチキャプチャーが許可されます。

レスポンスでは、amount_details フィールドに PaymentIntent で指定されたライン項目が含まれます。

PaymentIntent をキャプチャする

• amount_details は、作成時に指定されていない場合でも、最初のキャプチャーに追加できます。
• 作成時にamount_detailsを指定した場合は、最初のキャプチャー時にamount_detailsを渡すか、設定を解除する必要があります。

同じルールがamount_details[line_items]にも適用されます。作成時に指定されていない場合は、最初のキャプチャーで追加できますが、作成時に指定されていた場合は、追加するか明示的に設定解除する必要があります。

レスポンスのamount_detailsフィールドには、最初のキャプチャーで指定されたライン項目が含まれます。

PaymentIntent のステータスは requires_capture のままです。この時点で、次のいずれかを実行できます。

• PaymentIntent の全額まで PaymentIntent を複数回キャプチャーします。
• final_captureをtrueに設定するか、final_captureパラメーターを指定せずにキャプチャーを行うことで、PaymentIntentを成功状態に移行します(final_captureのデフォルトはtrueであるため)。

オーバーキャプチャー

決済項目は、オーバーキャプチャー中に使用できます。

未キャプチャーの PaymentIntent を作成して確定する

PaymentIntent の作成時に capture_method を manual として指定し、if_available パラメーターを使用して、この決済のオーバーキャプチャーをリクエストします。作成された PaymentIntent では、決済手段がサポートしている場合にオーバーキャプチャーが許可されます。

レスポンスでは、amount_details フィールドに PaymentIntent で指定されたライン項目が含まれます。

PaymentIntent をキャプチャする

PaymentIntent で現在オーソリゼーションされている金額を超える金額をキャプチャーするには、 capture エンドポイントを使用し、maximum_amount_capturable までの amount_to_capture を指定します。

キャプチャー中のキャプチャー金額と整合性のとれた更新後の amount_details ハッシュを渡します。

レスポンスの amount_details フィールドには、キャプチャー中に指定された項目が含まれます。

増分オーソリ

増分オーソリ中に決済明細項目を使用して、最初のオーソリ後に PaymentIntent で追加の金額をオーソリできます。

未キャプチャーの PaymentIntent を作成して確定する

PaymentIntent の作成時に capture_method を manual として指定し、if_available パラメーターを使用して、この決済の増分オーソリをリクエストします。作成された PaymentIntent では、決済手段がサポートしている場合に増分オーソリが許可されます。

レスポンスでは、amount_details フィールドに PaymentIntent で指定されたライン項目が含まれます。

オーソリを増やす

PaymentIntent で当初のオーソリ金額を超える金額をオーソリするには、increment_authorization エンドポイントを使用し、決済手段でサポートされている最大増分オーソリ金額を上限とする amount を指定します。

増分後のオーソリされた合計金額と整合性の取れた、更新後の amount_details ハッシュを渡します。

レスポンスの amount_details フィールドには、増分オーソリ時に指定された明細項目が含まれ、PaymentIntent のオーソリされた合計金額が更新されます。