Verify & complete checkout
[Step 3 of 7] The buyer is redirected to checkoutResultReturnUrl after Amazon Pay has processed the transaction or setup. The Amazon Pay checkout session ID will be included as a query parameter.
In this step, you will use the checkout session ID to confirm that the buyer has successfully returned to your site. At the end of this step, you will be able to present the buyer with the checkout result.
1. Complete Checkout Session
Use Complete Checkout Session to confirm that the buyer has successfully returned to your site.
Note:
chargeAmountis not required for Saved Wallet setup intent flow.- Amazon Pay will not finalize the Saved Wallet setup until you confirm checkout with Complete Checkout Session. Any Checkout Session that is not confirmed within 24 hours will be cancelled.
Successful response:
Complete Checkout Session will return a success response if the setup was processed successfully.
Error response:
Complete Checkout Session will return an error response for failed transactions. The buyer either canceled checkout or was unable to provide a valid payment instrument. You should:
- Redirect the buyer to the start of checkout
- Display a message such as: "Your request to save Amazon Pay as a payment method was not successful. Please try again.“
Request
Request body
{ }
Request parameters
| Name
|
Location
|
Description
|
| checkoutSessionId (required) Type: string |
Path parameter
|
Checkout Session identifier
|
Response
Returns HTTP 200 status response code if setup was successful
{
"checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
"webCheckoutDetails": null,
"chargePermissionType": PaymentMethodOnFile,
"recurringMetadata": null,
"productType": null,
"paymentDetails": null,
"merchantMetadata": null,
"paymentMethodOnFileMetadata": null,
"supplementaryData":null, // Amazon Pay system data
"buyer": null,
"billingAddress": null,
"paymentPreferences": [
null
],
"statusDetails": {
"state": "Completed",
"reasonCode": null,
"reasonDescription": null,
"lastUpdatedTimestamp": "20191015T204327Z"
},
"shippingAddress": null,
"platformId":null,
"chargePermissionId": "S01-5105180-3221187",
"chargeId": "S01-5105180-3221187-C056351",
"constraints": [
null
],
"creationTimestamp": "20191015T204313Z",
"expirationTimestamp": null,
"storeId": null,
"deliverySpecifications": null,
"providerMetadata": null,
"releaseEnvironment": null
}