CV1からの変更
全体像
- CV1との違い:CV2の主な改善点、CV2のUXフロー(CV2デモサイト)、CV1からの機能変更箇所
- CV2インテグレーションの流れ:CV2のUI/UXとインテグレーションの流れ(例)
- インテグレーション資料:インテグレーションガイド
CV1とは
Amazon Pay CV1(Checkout Version 1)はCV2リリース前に用いられていた旧バージョンのAmazon Pay Checkoutとなります。AmazonはCV1のDeprecationを予定しており、CV2への移行が必要となります。Deprecation後は以降の取引が停止となります。なおCV1のインテグレーションポータルページに記載されているもの、CV1のインテグレーションの為にAmazon Payより提供していたサンプルコードなど全てがDeprecationの対象となります。
CV2の主な改善点
大きく以下の3点が、CV2の改善点となります。
1. ITPへの対応 CV1ではCookie利用のため、ブラウザのセキュリティー強化(ITP)の影響を考慮し、対応が必要 ▼ CV2ではCookieを利用せずに処理を行うため、対応が不要 | 2. サイトデザインへの影響が減少 CV1ではボタンはサイズ4種類からのみ選択 アドレス帳・支払い方法はウィジェットを埋め込む実装が必要 ▼ CV2ではボタンの縦横を指定可能 アドレス帳・支払い方法はAmazon側の画面で選択 | 3. オーソリのエラー制御が容易に CV1ではオーソリ処理で複雑な判定制御を事業者様のサイト側で実施が必要 ▼ CV2ではAmazon側で制御 サイト側は成功時の遷移先・失敗時の遷移先を指定するだけで導入可能 |
*ITP(intelligent tracking prevention)とは、広告やアフィリエイトからユーザーのプライバシー保護が主目的のブラウザ機能で、主にユーザー情報の記録・保存ができるCookieの利用制限を強化する方向になっております。
CV2のUXフロー(CV2版デモサイト)
CV2デモサイトを参照ください。
CV1からの機能変更箇所
機能 | CV1からの変更有無 | コメント |
---|---|---|
ボタン | 変更あり | ボタン表示の実装方法が刷新。お届け先・支払い方法ウィジェット実装は不要。 |
API | 変更あり | APIの種類・APIの呼び出し方法が刷新。 |
IPN (インスタント通知) | 変更あり | 通知される内容がIDのみとなる。 事業者側でGetを用いて本文を取得する形に変更。 |
セラーセントラル | 変更あり | API認証キーの発行機能が追加。 取引管理は、CV2のオブジェクトもCV1に変換され表示される。ステータスなどの読み替えが必要となる。 FAQ - セラーセントラルのレポートはどのように確認すればよいですか? |
購入者用通知メール | 変更あり | オーソリのキャンセル通知が追加される。 ※CheckoutSession有効期限内にCompleteCheckoutSessionを実施されなければ、送付される。 FAQ - 購入者に配信されるメール本文の内容を知りたいです。 |
購入者用マイページ | 変更なし | - |
CV2版UI/UXとインテグレーションの流れ(例)
OneTime (都度払い)およびRecurring (継続払い)
OneTime Integration Flow を参照ください
インテグレーションガイド
CV2を導入する事業者様向けに、実装手順を記載した「インテグレーションガイド」 及び「APIリファレンス」を提供しています。
https://developer.amazon.com/ja/docs/amazon-pay/intro.html
- 本ページでは、デモサイト、設計例も公開しています。
- 本ページから、SDK、サンプルコードをダウンロードしてご利用ください。
インテグレーションガイドの中には、CV2へのアップグレードに関して記載しているページもあります。
CV2へのアップグレード
CV2のFAQも順次追加していますので、ぜひご活用ください。
http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/index.html
FAQ例
- 本番環境へ切り替えるために必要なことを知りたいです。
- アカウント情報として何が取得できますか?
- 再オーソリの処理方法を教えてください。
CV2の概要
CV2では、ボタンの表示方法・APIの全てが刷新されます。 ここでは実装を進める上でのポイントをまとめます。
APIの呼び出し方
CV2APIのオブジェクトの概念
CV2実装における処理フロー
CV2実装における留意点
CV1 vs CV2 オブジェクト
下図はOneTime(都度払い)利用時のAmazon Pay CV1オブジェクトに対するCV2オブジェクトのマッピングです。
Pから始まるものはオブジェクトのIDですが、一部変更がありますので、ご注意ください。
CV1 vs CV2 API
下表はOneTime(都度払い)利用時のAmazon Pay CV1 APIに対するCV2 APIのマッピングです。
主な機能 | CV1 | CV2 | ||
---|---|---|---|---|
API名 | パラメータ(※) | API名 | パラメータ(※) | |
Amazon Pay button(ボタン) | CV1 button script (JavaScript) | Redirected URL (Get OrderReferenceID with address widget) | CV2 button script (JavaScript) | Redirected URL (Get CheckoutSessionID by URL parameter) |
Shipping address(お届け先住所) | GetOrderReferenceDetails | GetCheckoutSession | ||
注文データ作成、決済、オーソリ | SetOrderReferenceDetails ConfirmOrderReference Authorize | Order amount | UpdateCheckoutSession | Order amountReturn URL after Amazon Pay ordering page. |
決済完了 | - | CompleteCheckoutSession | ||
売上請求 | Capture | Order amount | CaptureCharge | Order amount |
再オーソリ | Authorize | Order amount | CreateCharge | Order amount |
返金 | Refund | Order amount | CreateRefund | Order amount |
*KeyIDs、 region、currency code除く
補足説明事項
その他の機能、よくある質問について
CV2実装の補足として以下3点について説明します。
アカウント項目
CV1と同様に購入者情報、アドレス帳(shippingAddress)に加えて、請求先住所(billingAddress)もご利用いただけます。
※アカウント情報を取得するには、適切なスコープを設定する必要があります。
✓ フリガナ・生年月日・性別は保持しておらず提供不可
✓ カード情報(カードブランド・下4桁など)も提供不可
✓ ギフト券のみを選択された場合、請求先住所・購入者情報の電話番号は連携されない
詳細は FAQ - アカウント情報として何が取得できますか?
セラーセントラル (CV1から変更なし)
セラーセントラルの操作方法及び表示文言にCV1から変更はありません。
ECサイトで保持しているCV2のオブジェクト・ステータスの情報とセラーセントラルの表示情報 とを突き合わせる等の場合、セラーセントラル上の表示の読み替えが必要です。
詳細は FAQ - セラーセントラルのレポートはどのように確認すればよいですか?
配信メール
Amazonからの購入者に配信されるメールについてはCV1から1種類の追加があります。
- 追加された配信パターン
CompleteCheckoutSessionを実施しない場合に、 取得したオーソリ・売上請 求のキャンセルを通知するメールの配信が追加されました。
FAQ - 購入者に配信されるメール種類と配信タイミングを知りたいです。
- 配信されるメールの詳細
FAQ - 購入者に配信されるメール本文の内容を知りたいです。
アドバンスド機能
分割チャージ
1取引の中で、発送・請求タイミングの異なる注文を扱う場合に、売上請求を分けて実施することが可能です。
詳細はこちら
増額 減額チャージ
増額(追加請求)のオーソリを行ったり、減額後の金額で売上請求することで処理することができます。
詳細はこちら
受注から180日を超える売上請求
Amazon PayのChargePermissionの有効期限は、通常生成されてから180日ですが、ある設定を行うことで13ヶ月に延長することが可能です。有効期限の延長が必要な場合にご利用下さい。
詳細はこちら
ログイン連携
マイページへログインなどに、Amazonアカウントでログインする為のボタンをご利用頂けます。
SignIn機能を用いて、ユーザー(ご購入者)の識別※を行うことが可能です。
※ユーザーのログインに伴い、ユーザーごとのユニークなID(BuyerId)を渡すことができますので、事業社様側で保持している会員番号と紐付けなどを行えます。
また、住所情報は会員登録の補助などにご利用頂くことが可能です。
貴社会員番号とAmazonアカウントでサインイン後の取得可能なユーザIDを紐付けられるように、DBへのカラム・またはテーブル追加を行う必要があります。
- サインインの実装詳細は こちら
- FAQ - 「Amazonでログイン」ボタン (SignIn機能)で、何が取得できますか?
今すぐ支払うフロー(AdditionalPaymentButton機能)
AdditinalPaymentButton(APB)機能をご利用いただくと、決済手段の一つとしてAmazon Payをご利用頂けます。
APB機能では、通常のAmazon Pay機能とは異なり、注文確認画面を挟まずに、Amazon Pay で管理する画面からスムーズ に支払い完了のフローを構築することができます。
配送の伴う商材・デジタル商材ともに、この機能をご利用頂くことが可能です。
ただし、配送の伴う商材でAPB機能を用いた場合は、Amazonアカウントの住所をご利用頂くことができません。
- フロー図
- Additional Payment Buttonの実装詳細はこちら
- FAQ - AdditionalPaymentButton(APB)機能について知りたいです。
CV2導入検討段階でよくある質問
Q. CV1とCV2の併用は可能ですか?
A. CV1で作成したBillingAgreement/Authorization/Captureオブジェクトを、CV2のAPIでオーソリする/売上請求 する/返金することが可能です。 詳細は、以下のFAQをご確認ください http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/detail.html?id=QA-16Q. CV2の場合にデータベース等に保管が必要な情報は何ですか?
A. 取引の特定・API呼び出しに必要な ChargePermissionId(Amazon Payの注文ID)、ChargeId(オーソリ/売上請求の取引ID)、 RefundId(返金の取引ID) 、及び BuyerId(購入者固有のID) を保管しておくことを推奨します。 詳細は、以下のFAQをご確認ください http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/detail.html?id=QA-19Q. Recurringで課金できる上限はありますか?
A. Recurringでは、一つのCharge Permissionにつき、毎月の上限は10万円です。Q. セラーセントラルから継続支払いの情報である ChargePermissionId(Recurring用)を確認できますか?
A. セラーセントラルの取引管理画面にはChargePermissionId(Recurring用)は表示されません。そのため、継続支払い情報を確認したい場合は、API実行して取得した情報を御社システム側で保持していただく 必要があります(子情報に当たる毎月等の取引データ(Chargeレコード)はセラーセントラルで確認できます)Q. Charge Permissionに紐づけているお届け先、支払い方法を変 更することは可能ですか?
A. お届け先については、購入者が後に変更することはできません。 この場合は、購入者に改めて契約を行って頂く必要があります。 支払い方法については、購入者がAmazon Payのマイページを利用して、支払い方法を変更することが可能です。 http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/detail.html?id=QA-47Q. 2回目以降の請求が失敗することはありますか?
A. はい。購入者のカードの状況によってありえます。(例:カードの有効期限切れ など) このような場合は、事業者から購入者に連絡を行い、購入者の支払い方法を更新して頂いた後に、再度請求のリ クエスト(API call)を行う必要があります。 http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/detail.html?id=QA-45Q. Recurringの継続支払いを、購入者が事業者サイト以外で解除することはできますか?
はい。Amazon Payのマイページより、継続支払いを解除することが可能です。 ※あくまでAmazon Payの継続支払いの解約です。貴社が提供するサービスの解約は貴社規約等に準じてくださ い。 継続支払いが解除された場合の対応方法については、以下のFAQをご確認ください。 http://amazonpay-integration.amazon.co.jp/amazonpay-faq-v2/detail.html?id=QA-43FAQ - CV1(旧バージョン)を利用しながら、開発環境(SANDBOX)でCV2(新バージョン)のテストを実施できますか。
FAQ - 自社のECサイトで利用しているAmazon PayのバージョンがCV1かCV2かを見分ける方法はありますか?