Charge Permission
(checkoutSessionId)
(chargePermissionId)
(chargeId)
(refundId)
Get Charge Permission
- JP
- US
- EU/UK
Get Charge Permissionはいつ使うの？
- チェックアウトセッションを完了すると、Get Checkout Session APIでは注文内容の詳細（お届け先住所やお支払い方法、金額等）を取得できなくなりますので、 セッション完了後に注文詳細を取得する場合はGet Charge Permission APIを呼び出して情報を取得します。
- 再オーソリを行う予定がある場合は、再オーソリ（Create Charge API）実行時にエラーとなる可能性があります。原因として考えられるのは登録しているクレジットカード等の支払い方法に問題がある等ですが、エラーの原因を調査する際にGet Charge Permission APIを実行します。
- また、継続支払い (Recurring) の場合ですが、継続支払いのCharge Permissionは、Amazon Payご利用履歴ページでお客様自身が解除 (close)することが可能な仕様になっています。このような場合は、Amazon PayでのCharge PermissionはCloseとなりますが、事業者側で管理しているオーダー情報は残った状態となります。
この状態で、次回事業者が Create Charge API(オーソリ取得)を実行すると失敗しますので、Get Charge Permission APIを使用してCharge Permissionの状態や理由を確認します。
- オブジェクト間の関係性でご説明した通り、ChargeはCharge Permissionに紐づいており、Create Charge APIが失敗した場合はその大元の情報となるCharge Permissionの状態を確認する必要があります。
- 詳細情報は Charge Permissionが作成されてから30日間のみ取得できます。
特に配送が伴う継続支払いの場合に、Create Charge API をせずに商品の仕入れや配送を実施してしまうと、後になってからCreate Charge APIができなくなっていること（Amazon Payのページからお客様がCharge PermissionをCloseしていたこと）に気づき、デッドストック等のリスクが発生しますので、上記の点を考慮して最適な処理フローをご検討ください。
参考: インテグレーションガイド - Get Charge Permission
Update Charge Permission
- JP
- US
- EU/UK
Update Charge Permissionはいつ使うの？
- 事業者側の注文番号が確定していない状態でセッションを完了 (Complete Checkout Session)するケースがあるかもしれません。そのような場合に、注文番号が確定してからUpdate Charge Permission APIを実行して事業者の注文番号をCharge Permissionオブジェクトへ反映することが可能です。
参考: FAQ - OneTime（都度支払い）で、注文時のAmazon Pay API処理フロー（通常／複数オーソリ／Dynamic Authorization）を知りたいです。 - また、継続支払い (Recurring) のケースですが、例えばセッション完了時に設定した継続支払いの頻度や金額が変更となるケースがあるかと思います。 そういった場合は、Update Charge Permission APIを使用して、更新後の頻度や金額をCharge Permissionオブジェクトへ反映する必要があります。
Update Charge Permission APIを実行することで変更後の頻度や金額は即時にCharge Permissionオブジェクトへ反映されますが、expirationTimeStampは更新後のCharge Permissionに対して新たなChargeを生成した際に更新されますので、ご注意ください。
なぜ反映しないといけないの？（定期支払いで利用した場合）反映したらAmazonが一定の頻度で自動的にオーソリを実行してくれるの？
セッション完了後のオーソリ実行（例えば継続支払いの２回目以降のオーソリ）は、常に事業者側で実行していただく必要があります。Amazonが自動で実行することはありません。
また、Charge Permissionに保存されている頻度や金額は Amazon Payご利用履歴ページ 上でお客様に表示されますので、適切な更新をお願いいたします。
参考:
Close Charge Permission
- JP
- US
- EU/UK
Close Charge Permissionはいつ使うの？
- オーソリを取得した後で何らかの事情が発生し、売上請求（実売上）をする前にオーソリをキャンセルする場合があるかと思います。そういった場合には、ChargeおよびChargeの許諾を表すCharge Permissionの両方を、以下のいずれかの方法でクローズします。
- cancelPendingCharges パラメータをtrueに設定した上で、Close Charge Permission APIを実行（このように実行すると、Charge Permissionをクローズするとともに、実売上を完了していないChargeも一緒にクローズ処理します）
- Cancel Charge APIおよびClose Charge Permission APIを実行
- また、継続支払い (Recurring) のケースですが、事業者とお客様の間で継続支払いの注文が終了した場合、当該情報はAmazonで把握することができません。そのため、注文が終了した場合には、事業者Close Charge Permission APIを呼び出して、該当のCharge Permissionをクローズする必要があります。
なぜ対応しないといけないの？
事業者側でClose Charge Permission APIを呼び出さなくても、Charge Permissionが13ヶ月間使用されない場合はAmazon側で自動的にCharge Permissionをcloseします。しかしながら、それまでの間はCharge Permissionが生きている状態になります。 お客様は Amazon Payご利用履歴ページで継続支払いの一覧を確認することができますので、Closeしていない場合はその一覧の中で継続支払いが生きているように見えます。そういったケースでは不安に思ったお客様が事業者へお問い合わせする可能性が出てきますので、不要なお問い合わせをなくすためにも、Close Charge Permissionの対応をお願いいたします。