Skip to main content

Objects

What's Object?​

Below diagram shows objects created from Amazon Pay button click to checkout complete on website.
Diagram is horizontal, and flows from left to right. Scroll the diagram to the right to see all flow.

Merchant site
● ● ●
Cart page
Amazon Pay
● ● ●
Order review page
● ● ●
Order confirmation page
✔️
Amazon Pay Hosted page
Merchant
Objects created during checkout
Session initiated
Checkout Session
(checkoutSessionId)
Order confirmation
Charge Permission
(chargePermissionId)
Authorization/Settlement
Charge
(chargeId)

Three objects appear in above diagram. You call Amazon Pay APIs against these object in subsequent processes to get shiping address and/or complete checkout etc.

  • Checkout Session (Checkout Session represents a single active session (or engagement) for the buyer on your website)
  • Charge Permission (Object created during checkout session completion)
  • Charge (Object created when authorization is is initiated)

There are two additional objects appers in post-checkout or in different scenario.

  • Refund (Object created when refund is performed)
  • Buyer (Object that contains Amazon buyer information)

Object relationship​

info

Relationship between objects for OneTime and Recurring checkout

Checkout Session
(checkoutSessionId)
1 : 1
Charge Permission
(chargePermissionId)
1<=n<=25
Charge
(chargeId)
1<=n<=10
Refund
(refundId)
・ You can create up to 25 "Open" state Charge against Charge Permission.
・ Closed charge is not included in the count.
・ You can create up to 10 Refund against Charge, meaning you can make split refund up to 10 times.