Version 2 migration guide
API version 2 introduces breaking changes. Update the API endpoint version parameter and follow this guide to migrate from version 1 to version 2.
API contract updates
Some parameters have been renamed or restructured. Check the changes below and update your code if it specifically references one of the affected parameters.
Checkout Session
| Parameter
|
Change Description
|
| billingAddress
|
billingAddress moved from paymentPreferences array to top level node
|
| webCheckoutDetail
|
webCheckoutDetail renamed to webCheckoutDetails
|
| paymentDetail
|
paymentDetail renamed to paymentDetails
|
| statusDetail
|
statusDetail renamed to statusDetails
|
Charge Permission
| Parameter
|
Change Description
|
| billingAddress
|
billingAddress moved from paymentPreferences array to top level node
|
| chargeAmountLimit
|
Replaced with limits which encapsulates amountLimit and accountBalance
|
| statusDetail
|
statusDetail renamed to statusDetails
|
Charge
| Parameter
|
Change Description
|
| statusDetail
|
statusDetail renamed to statusDetails
|
Refund
| Parameter
|
Change Description
|
| statusDetail
|
statusDetail renamed to statusDetails
|
Complete Checkout Session API
Version 2 Checkout Session objects must be confirmed once the buyer is redirected to amazonResultReturnUrl to finalize paymentIntent. Any Checkout Session that is not confirmed within 24 hours will be cancelled.
Replace the Get Checkout Session request used to verify the Checkout Session state once the buyer is redirected to amazonResultReturnUrl with a Complete Checkout Session request. Complete Checkout session will return a success response if transaction processing was successful. Otherwise, it will return an error response.
You do not have to update any other logic you might have implemented for authorizing and capturing payment.