Checkout Session
(checkoutSessionId)
(chargePermissionId)
(chargeId)
(refundId)
Get Checkout Session
- JP
- US
- EU/UK
Get Checkout Sessionはいつ使うの？
お客様がAmazon Payボタンをクリックすると、Amazonのページへリダイレクトされ、ログインおよびお届け先+支払い方法を選択します。選択が完了すると事業者の指定するURL (checkoutReviewReturnUrl) へ再度リダイレクトされます。
この際に、Amazon側で生成したCheckout Sessionオブジェクトの checkoutSessionId がURLパラメーターとして連携されます。
このcheckoutSessionIdを使って、事業者側でGet Checkout Session APIを呼び出し、お客様の情報 (お届け先やお支払い方法含む）を取得する必要があります。
取得したら、お届け先やお支払い方法を事業者の「注文確認ページ」に表示します。
（下図オレンジ枠で囲った部分の間で実行します）
| 事業者サイト | |||||
● ● ● カートページ  | ● ● ● 注文確認ページ | ● ● ● 注文完了ページ ✔️ | |||
| Amazonページ | |||||
 |  Merchant | ||||
例) 事業者の指定するURL (checkoutReviewReturnUrl)が https://anyurl.com/review/ である場合、
https://anyurl.com/review/? amazonCheckoutSessionId=26be7331-7dc2-4722-be22-f7e75582d3ef
のような形で、checkoutSessionIdが連携されます。
参考:
Update Checkout Session
- JP
- US
- EU/UK
Update Checkout Sessionはいつ使うの？
事業者の「注文確認ページ」で、送料やクーボン割引などを踏まえた最終金額が確定するかと思います。
そのため、お客様が「注文確定」ボタンをクリックした際に、事業者側でUpdate Checkout Session APIを呼び出し、最終金額等を該当のCheckout Sessionオブジェクトへ反映します。
（下図オレンジ枠で囲った部分の間で実行します）
| 事業者サイト | |||||
● ● ● カートページ | ● ● ● 注文確認ページ | ● ● ● 注文完了ページ ✔️ | |||
| Amazonページ | |||||
| Merchant | ||||
例えばボタンをレンダリングする時点で最終金額やお届け先が決まっている場合には、APB (Additional Payment Button) をご利用ください。
参考:
Complete Checkout Session
- JP
- US
- EU/UK
Complete Checkout Sessionはいつ使うの？
事業者の「注文内容確認画面」でお客様が「注文確定」ボタンをクリックした際（Update Checkout Sessionが必要な場合は Update Checkout Session完了後）、 事業者はamazonPayRedirectUrlへリダイレクトします。Amazon側で処理が完了すると、再び事業者の指定するURL (checkoutResultReturnUrl) へリダイレクトしますので、その際にこのチェックアウトセッションを完了させるために実行するAPIです。 （下図オレンジ枠で囲った部分の間で実行します）
| 事業者サイト | |||||
● ● ● カートページ | ● ● ● 注文確認ページ | ● ● ● 注文完了ページ ✔️ | |||
| Amazonページ | |||||
| Merchant | ||||
Checkout Sessionは24時間有効ですので、例えばお客様が決済を最後まで完了せずにページを離れてしまった、または、時間を空けてから「注文確定」ボタンをクリックするといったシチュエーションがある場合でも、24時間以内であれば同Checkout Sessionを使って決済を完了させることができます。
このような利用をする場合は、Checkout SessionのIDである checkoutSessionIdを事業者注文情報を紐付けて管理してください。
Complete Checkout Session APIが成功裏に完了すると、responseで以下の２つのIDが連携されます。
- chargePermissionId
- chargeId（決済フローの中でオーソリまで取得している場合のみ）
これらのIDは、後続の処理で必要になりますので、事業者の注文情報と紐づけて保存してください。
参考: