Rust Requires Chilkat v11.0.0+
Rust
Amazon Pay - Create Checkout Session
See more Amazon Pay Examples
Create a new Amazon Pay Checkout Session.Chilkat Rust Downloads
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = chilkat::Http::new();
// Implements the following CURL command:
// curl "https://pay-api.amazon.com/:version/checkoutSessions/" \
// -X POST
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
// -d '{
// "webCheckoutDetails": {
// "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
// },
// "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
// "scopes": ["name", "email", "phoneNumber", "billingAddress"],
// "deliverySpecifications": {
// "specialRestrictions": ["RestrictPOBoxes"],
// "addressRestrictions": {
// "type": "Allowed",
// "restrictions": {
// "US": {
// "statesOrRegions": ["WA"],
// "zipCodes": ["95050", "93405"]
// },
// "GB": {
// "zipCodes": ["72046", "72047"]
// },
// "IN": {
// "statesOrRegions": ["AP"]
// },
// "JP": {}
// }
// }
// }
// }'
// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "webCheckoutDetails": {
// "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
// },
// "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
// "scopes": [
// "name",
// "email",
// "phoneNumber",
// "billingAddress"
// ],
// "deliverySpecifications": {
// "specialRestrictions": [
// "RestrictPOBoxes"
// ],
// "addressRestrictions": {
// "type": "Allowed",
// "restrictions": {
// "US": {
// "statesOrRegions": [
// "WA"
// ],
// "zipCodes": [
// "95050",
// "93405"
// ]
// },
// "GB": {
// "zipCodes": [
// "72046",
// "72047"
// ]
// },
// "IN": {
// "statesOrRegions": [
// "AP"
// ]
// },
// "JP": {}
// }
// }
// }
// }
let json = chilkat::JsonObject::new();
let _ = json.update_string("webCheckoutDetails.checkoutReviewReturnUrl", "https://a.com/merchant-review-page");
// Make sure to use your storeId here:
let _ = json.update_string("storeId", "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId");
let mut i = 0;
json.set_i(i);
let _ = json.update_string("scopes[i]", "name");
i = i + 1;
json.set_i(i);
let _ = json.update_string("scopes[i]", "email");
i = i + 1;
json.set_i(i);
let _ = json.update_string("scopes[i]", "phoneNumber");
i = i + 1;
json.set_i(i);
let _ = json.update_string("scopes[i]", "billingAddress");
let _ = json.update_string("deliverySpecifications.specialRestrictions[0]", "RestrictPOBoxes");
let _ = json.update_string("deliverySpecifications.addressRestrictions.type", "Allowed");
let _ = json.update_string("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]", "WA");
let _ = json.update_string("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]", "95050");
let _ = json.update_string("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]", "93405");
let _ = json.update_string("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]", "72046");
let _ = json.update_string("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]", "72047");
let _ = json.update_string("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]", "AP");
let _ = json.update_new_object("deliverySpecifications.addressRestrictions.restrictions.JP");
// Load your Amazon Pay private key.
// There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
// or from in-memory strings or bytes.
let priv_key = chilkat::PrivateKey::new();
if priv_key.load_pem_file("C:/someDir/myAmazonPayPrivateKey.pem").is_err() {
println!("{}", priv_key.last_error_text());
return;
}
// Provide your Amazon Pay private key and Public Key ID
// Use your public key ID here. It must be the one associated with the private key.
// Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
let public_key_id = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW".to_string();
if http.set_auth_private_key(&public_key_id, &priv_key).is_err() {
println!("{}", http.last_error_text());
return;
}
// Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
// and will also sign the request. Nothing more is needed.
// Chilkat automatically generates and adds the following headers:
//
// x-amz-pay-date
// x-amz-pay-host
// x-amz-pay-region
// x-amz-pay-idempotency-key
// Authorization
http.set_accept("application/json");
// To use the live system, replace "sandbox" with "live" in the URL passed to HttpJson.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
let resp = chilkat::HttpResponse::new();
if http.http_json("POST", "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/", &json, "application/json", &resp).is_err() {
println!("{}", http.last_error_text());
return;
}
let sb_response_body = chilkat::StringBuilder::new();
let _ = resp.get_body_sb(&sb_response_body);
let j_resp = chilkat::JsonObject::new();
let _ = j_resp.load_sb(&sb_response_body);
j_resp.set_emit_compact(false);
// If the status code is not equal to 201, this will display error information.
println!("Response Body:");
println!("{}", j_resp.emit().unwrap_or_default());
let resp_status_code = resp.status_code();
println!("Response Status Code = {}", resp_status_code);
if resp_status_code != 201 {
// The jResp would've contained an error message, similar to this:
// {
// "reasonCode": "InvalidHeaderValue",
// "message": "The value AF2EGWREIPHV2S2TUFFBRDGM provided for PublicKeyId is invalid. Please verify that you are using the PublicKeyId in the correct region and environment."
// }
println!("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
// "webCheckoutDetails": {
// "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
// "checkoutResultReturnUrl": null,
// "checkoutCancelUrl": null,
// "amazonPayRedirectUrl": null
// },
// "productType": "PayAndShip",
// "chargePermissionType": "Recurring",
// "recurringMetadata": {
// "frequency": {
// "unit": "Month",
// "value": "1"
// },
// "amount": {
// "amount": "30",
// "currencyCode": "USD"
// }
// },
// "paymentDetails": {
// "paymentIntent": null,
// "canHandlePendingAuthorization": false,
// "chargeAmount": null,
// "totalOrderAmount": null,
// "softDescriptor": null,
// "presentmentCurrency": null,
// "allowOvercharge": null,
// "extendExpiration": null
// },
// "merchantMetadata": {
// "merchantReferenceId": null,
// "merchantStoreName": null,
// "noteToBuyer": null,
// "customInformation": null
// },
// "supplementaryData": null,
// "buyer": null,
// "billingAddress": null,
// "paymentPreferences": [
// null
// ],
// "statusDetails": {
// "state": "Open",
// "reasonCode": null,
// "reasonDescription": null,
// "lastUpdatedTimestamp": "20191015T204327Z"
// },
// "shippingAddress": null,
// "platformId": null,
// "chargePermissionId": null,
// "chargeId": null,
// "constraints": [
// {
// "constraintId": "BuyerNotAssociated",
// "description": "There is no buyer associated with the Checkout Session. Return the checkout session id to the Amazon Pay Button to allow buyer to login."
// },
// {
// "constraintId": "ChargeAmountNotSet",
// "description": "chargeAmount is not set."
// },
// {
// "constraintId": "CheckoutResultReturnUrlNotSet",
// "description": "checkoutResultReturnUrl is not set."
// },
// {
// "constraintId": "PaymentIntentNotSet",
// "description": "paymentIntent is not set."
// }
// ],
// "creationTimestamp": "20191015T204313Z",
// "expirationTimestamp": "20191016T204313Z",
// "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
// "deliverySpecifications": {
// "specialRestrictions": [
// "RestrictPOBoxes"
// ],
// "addressRestrictions": {
// "type": "Allowed",
// "restrictions": {
// "US": {
// "statesOrRegions": [
// "WA"
// ],
// "zipCodes": [
// "95050",
// "93405"
// ]
// },
// "GB": {
// "zipCodes": [
// "72046",
// "72047"
// ]
// },
// "IN": {
// "statesOrRegions": [
// "AP"
// ]
// },
// "JP": {}
// }
// }
// },
// "providerMetadata": {
// "providerReferenceId": null
// },
// "releaseEnvironment": "Sandbox"
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
let checkout_session_id = j_resp.string_of("checkoutSessionId").unwrap_or_default();
let web_checkout_details_checkout_review_return_url = j_resp.string_of("webCheckoutDetails.checkoutReviewReturnUrl").unwrap_or_default();
let web_checkout_details_checkout_result_return_url = j_resp.string_of("webCheckoutDetails.checkoutResultReturnUrl").unwrap_or_default();
let web_checkout_details_checkout_cancel_url = j_resp.string_of("webCheckoutDetails.checkoutCancelUrl").unwrap_or_default();
let web_checkout_details_amazon_pay_redirect_url = j_resp.string_of("webCheckoutDetails.amazonPayRedirectUrl").unwrap_or_default();
let product_type = j_resp.string_of("productType").unwrap_or_default();
let charge_permission_type = j_resp.string_of("chargePermissionType").unwrap_or_default();
let recurring_metadata_frequency_unit = j_resp.string_of("recurringMetadata.frequency.unit").unwrap_or_default();
let recurring_metadata_frequency_value = j_resp.string_of("recurringMetadata.frequency.value").unwrap_or_default();
let recurring_metadata_amount_amount = j_resp.string_of("recurringMetadata.amount.amount").unwrap_or_default();
let recurring_metadata_amount_currency_code = j_resp.string_of("recurringMetadata.amount.currencyCode").unwrap_or_default();
let payment_details_payment_intent = j_resp.string_of("paymentDetails.paymentIntent").unwrap_or_default();
let payment_details_can_handle_pending_authorization = j_resp.bool_of("paymentDetails.canHandlePendingAuthorization");
let payment_details_charge_amount = j_resp.string_of("paymentDetails.chargeAmount").unwrap_or_default();
let payment_details_total_order_amount = j_resp.string_of("paymentDetails.totalOrderAmount").unwrap_or_default();
let payment_details_soft_descriptor = j_resp.string_of("paymentDetails.softDescriptor").unwrap_or_default();
let payment_details_presentment_currency = j_resp.string_of("paymentDetails.presentmentCurrency").unwrap_or_default();
let payment_details_allow_overcharge = j_resp.string_of("paymentDetails.allowOvercharge").unwrap_or_default();
let payment_details_extend_expiration = j_resp.string_of("paymentDetails.extendExpiration").unwrap_or_default();
let merchant_metadata_merchant_reference_id = j_resp.string_of("merchantMetadata.merchantReferenceId").unwrap_or_default();
let merchant_metadata_merchant_store_name = j_resp.string_of("merchantMetadata.merchantStoreName").unwrap_or_default();
let merchant_metadata_note_to_buyer = j_resp.string_of("merchantMetadata.noteToBuyer").unwrap_or_default();
let merchant_metadata_custom_information = j_resp.string_of("merchantMetadata.customInformation").unwrap_or_default();
let supplementary_data = j_resp.string_of("supplementaryData").unwrap_or_default();
let buyer = j_resp.string_of("buyer").unwrap_or_default();
let billing_address = j_resp.string_of("billingAddress").unwrap_or_default();
let status_details_state = j_resp.string_of("statusDetails.state").unwrap_or_default();
let status_details_reason_code = j_resp.string_of("statusDetails.reasonCode").unwrap_or_default();
let status_details_reason_description = j_resp.string_of("statusDetails.reasonDescription").unwrap_or_default();
let status_details_last_updated_timestamp = j_resp.string_of("statusDetails.lastUpdatedTimestamp").unwrap_or_default();
let shipping_address = j_resp.string_of("shippingAddress").unwrap_or_default();
let platform_id = j_resp.string_of("platformId").unwrap_or_default();
let charge_permission_id = j_resp.string_of("chargePermissionId").unwrap_or_default();
let charge_id = j_resp.string_of("chargeId").unwrap_or_default();
let creation_timestamp = j_resp.string_of("creationTimestamp").unwrap_or_default();
let expiration_timestamp = j_resp.string_of("expirationTimestamp").unwrap_or_default();
let store_id = j_resp.string_of("storeId").unwrap_or_default();
let delivery_specifications_address_restrictions_type = j_resp.string_of("deliverySpecifications.addressRestrictions.type").unwrap_or_default();
let provider_metadata_provider_reference_id = j_resp.string_of("providerMetadata.providerReferenceId").unwrap_or_default();
let release_environment = j_resp.string_of("releaseEnvironment").unwrap_or_default();
i = 0;
let mut count_i = j_resp.size_of_array("paymentPreferences");
while i < count_i {
j_resp.set_i(i);
let _ = j_resp.is_null_of("paymentPreferences[i]");
i = i + 1;
}
i = 0;
count_i = j_resp.size_of_array("constraints");
while i < count_i {
j_resp.set_i(i);
let _ = j_resp.string_of("constraints[i].constraintId").unwrap_or_default();
let _ = j_resp.string_of("constraints[i].description").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = j_resp.size_of_array("deliverySpecifications.specialRestrictions");
while i < count_i {
j_resp.set_i(i);
let _ = j_resp.string_of("deliverySpecifications.specialRestrictions[i]").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = j_resp.size_of_array("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions");
while i < count_i {
j_resp.set_i(i);
let _ = j_resp.string_of("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = j_resp.size_of_array("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes");
while i < count_i {
j_resp.set_i(i);
let _ = j_resp.string_of("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = j_resp.size_of_array("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes");
while i < count_i {
j_resp.set_i(i);
let _ = j_resp.string_of("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = j_resp.size_of_array("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions");
while i < count_i {
j_resp.set_i(i);
let _ = j_resp.string_of("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]").unwrap_or_default();
i = i + 1;
}