メインコンテンツまでスキップ

オブジェクト

オブジェクトとは

下図は、ECサイト上のAmazon Payボタンクリックから決済完了までの間にAmazon側で生成されるオブジェクトを表しています。

事業者サイト
● ● ●
カートページ
Amazon Pay
● ● ●
注文確認ページ
● ● ●
注文完了ページ
✔️
Amazonページ
Merchant
Amazonで生成するオブジェクト
セッション開始
Checkout Session
(checkoutSessionId)
注文情報保存
Charge Permission
(chargePermissionId)
オーソリ・売上請求
Charge
(chargeId)

上図の中には3つのオブジェクトが登場しています。 これらのオブジェクトは決済フロー毎に、決済開始〜完了までに生成されるオブジェクトです。 後続の処理では、これらのオブジェクトに対してAmazon Pay APIを実行し、Amazonアカウントの住所情報の取得や決済処理を行うことになります。

  • Checkout Session (アクティブなセッションを管理するためのオブジェクト)
  • Charge Permission (決済準備を開始する際に生成されるオブジェクト)
  • Charge (決済すると生成されるオブジェクト)

また、上記に加えて以下の2つのオブジェクトがあります。

  • Refund (返金処理を行うと生成されるオブジェクト)
  • Buyer (Amazonアカウント保有者の情報を保有するオブジェクト)

オブジェクト間の関係性

info

Checkout Session、Charge Permission、Charge、Refundの関係性は以下のとおりです。 (都度払いと継続払いで少し異なります。タブを切り替えてご覧ください)

Checkout Session
(checkoutSessionId)
1 : 1
Charge Permission
(chargePermissionId)
Charge
(chargeId)
Refund
(refundId)
・ ChargePermissionからステータスがOpenとなるChargeを25件まで生成することができます。
・ ChargeをCloseした場合(オーソリをキャンセルしたなど)は上記上限に含まれません。
・ Chargeに対して、Refundを10件まで生成することができます。つまり、10回分割して返金することができます。