(C#) Amazon Pay - Get Checkout Session

See more Amazon Pay Examples

Get Checkout Session details includes buyer info, payment instrument details, and shipping address.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#get-checkout-session

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

// Implements the following CURL command:

// curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId"
//   -X GET
//   -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
//   -H "x-amz-pay-date:20201012T235046Z"

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

// 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.
Chilkat.PrivateKey privKey = new Chilkat.PrivateKey();
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if (success == false) {
    Debug.WriteLine(privKey.LastErrorText);
    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
string publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = http.SetAuthPrivateKey(publicKeyId,privKey);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    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
// Authorization

http.Accept = "application/json";

int respStatusCode = 0;

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.SetUrlVar("sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b");
// To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
success = http.QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",sbResponseBody);
if (success == false) {
    // If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    respStatusCode = http.LastStatus;
    if (respStatusCode != 0) {
        Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
        // A sample response body for the case where the session ID does not exist:
        // {"reasonCode":"ResourceNotFound","message":"Resource you are trying to access is not available. Requested path '/sandbox/v2/checkoutSessions/bd504926-f659-4ad7-a1a9-9a747aaf5275'"}

        Debug.WriteLine("Response body:");
        Debug.WriteLine(http.LastResponseBody);
    }
    else {
        Debug.WriteLine(http.LastErrorText);
    }

    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
// We expect a 200 status code for success.
// Note: Some Amazon Pay API calls return 200 for success, others return 201.
if (respStatusCode != 200) {
    Debug.WriteLine("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
//   },
//   "chargePermissionType": "Recurring",
//   "recurringMetadata": {
//     "frequency": {
//       "unit": "Month",
//       "value": "1"
//     },
//     "amount": {
//       "amount": "30",
//       "currencyCode": "USD"
//     }
//   },
//   "productType": "PayAndShip",
//   "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": {
//     "buyerId": "buyerId",
//     "name": "name-1",
//     "email": "name@amazon.com",
//     "phoneNumber": "800-000-0000",
//     "primeMembershipTypes": null
//   },
//   "billingAddress": {
//     "name": "Work",
//     "addressLine1": "440 Terry Ave",
//     "addressLine2": "",
//     "addressLine3": "",
//     "city": "Seattle",
//     "county": "King",
//     "district": "Seattle",
//     "stateOrRegion": "WA",
//     "postalCode": "98121",
//     "countryCode": "US"
//   },
//   "paymentPreferences": [
//     {
//       "paymentDescriptor": "Your selected Amazon payment method"
//     }
//   ],
//   "statusDetails": {
//     "state": "Open",
//     "reasonCode": null,
//     "reasonDescription": null,
//     "lastUpdatedTimestamp": "20191015T204327Z"
//   },
//   "shippingAddress": {
//     "name": "Susie Smith",
//     "addressLine1": "10 Ditka Ave",
//     "addressLine2": "Suite 2500",
//     "addressLine3": null,
//     "city": "Chicago",
//     "county": null,
//     "district": null,
//     "stateOrRegion": "IL",
//     "postalCode": "60602",
//     "countryCode": "US",
//     "phoneNumber": "800-000-0000"
//   },
//   "platformId": null,
//   "chargePermissionId": null,
//   "chargeId": null,
//   "constraints": [
//     {
//       "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

string paymentDescriptor;
string constraintId;
string description;
string strVal;

string checkoutSessionId = jResp.StringOf("checkoutSessionId");
string webCheckoutDetailsCheckoutReviewReturnUrl = jResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl");
string webCheckoutDetailsCheckoutResultReturnUrl = jResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl");
string webCheckoutDetailsCheckoutCancelUrl = jResp.StringOf("webCheckoutDetails.checkoutCancelUrl");
string webCheckoutDetailsAmazonPayRedirectUrl = jResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl");
string chargePermissionType = jResp.StringOf("chargePermissionType");
string recurringMetadataFrequencyUnit = jResp.StringOf("recurringMetadata.frequency.unit");
string recurringMetadataFrequencyValue = jResp.StringOf("recurringMetadata.frequency.value");
string recurringMetadataAmountAmount = jResp.StringOf("recurringMetadata.amount.amount");
string recurringMetadataAmountCurrencyCode = jResp.StringOf("recurringMetadata.amount.currencyCode");
string productType = jResp.StringOf("productType");
string paymentDetailsPaymentIntent = jResp.StringOf("paymentDetails.paymentIntent");
bool paymentDetailsCanHandlePendingAuthorization = jResp.BoolOf("paymentDetails.canHandlePendingAuthorization");
string paymentDetailsChargeAmount = jResp.StringOf("paymentDetails.chargeAmount");
string paymentDetailsTotalOrderAmount = jResp.StringOf("paymentDetails.totalOrderAmount");
string paymentDetailsSoftDescriptor = jResp.StringOf("paymentDetails.softDescriptor");
string paymentDetailsPresentmentCurrency = jResp.StringOf("paymentDetails.presentmentCurrency");
string paymentDetailsAllowOvercharge = jResp.StringOf("paymentDetails.allowOvercharge");
string paymentDetailsExtendExpiration = jResp.StringOf("paymentDetails.extendExpiration");
string merchantMetadataMerchantReferenceId = jResp.StringOf("merchantMetadata.merchantReferenceId");
string merchantMetadataMerchantStoreName = jResp.StringOf("merchantMetadata.merchantStoreName");
string merchantMetadataNoteToBuyer = jResp.StringOf("merchantMetadata.noteToBuyer");
string merchantMetadataCustomInformation = jResp.StringOf("merchantMetadata.customInformation");
string supplementaryData = jResp.StringOf("supplementaryData");
string buyerBuyerId = jResp.StringOf("buyer.buyerId");
string buyerName = jResp.StringOf("buyer.name");
string buyerEmail = jResp.StringOf("buyer.email");
string buyerPhoneNumber = jResp.StringOf("buyer.phoneNumber");
string buyerPrimeMembershipTypes = jResp.StringOf("buyer.primeMembershipTypes");
string billingAddressName = jResp.StringOf("billingAddress.name");
string billingAddressAddressLine1 = jResp.StringOf("billingAddress.addressLine1");
string billingAddressAddressLine2 = jResp.StringOf("billingAddress.addressLine2");
string billingAddressAddressLine3 = jResp.StringOf("billingAddress.addressLine3");
string billingAddressCity = jResp.StringOf("billingAddress.city");
string billingAddressCounty = jResp.StringOf("billingAddress.county");
string billingAddressDistrict = jResp.StringOf("billingAddress.district");
string billingAddressStateOrRegion = jResp.StringOf("billingAddress.stateOrRegion");
string billingAddressPostalCode = jResp.StringOf("billingAddress.postalCode");
string billingAddressCountryCode = jResp.StringOf("billingAddress.countryCode");
string statusDetailsState = jResp.StringOf("statusDetails.state");
string statusDetailsReasonCode = jResp.StringOf("statusDetails.reasonCode");
string statusDetailsReasonDescription = jResp.StringOf("statusDetails.reasonDescription");
string statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp");
string shippingAddressName = jResp.StringOf("shippingAddress.name");
string shippingAddressAddressLine1 = jResp.StringOf("shippingAddress.addressLine1");
string shippingAddressAddressLine2 = jResp.StringOf("shippingAddress.addressLine2");
string shippingAddressAddressLine3 = jResp.StringOf("shippingAddress.addressLine3");
string shippingAddressCity = jResp.StringOf("shippingAddress.city");
string shippingAddressCounty = jResp.StringOf("shippingAddress.county");
string shippingAddressDistrict = jResp.StringOf("shippingAddress.district");
string shippingAddressStateOrRegion = jResp.StringOf("shippingAddress.stateOrRegion");
string shippingAddressPostalCode = jResp.StringOf("shippingAddress.postalCode");
string shippingAddressCountryCode = jResp.StringOf("shippingAddress.countryCode");
string shippingAddressPhoneNumber = jResp.StringOf("shippingAddress.phoneNumber");
string platformId = jResp.StringOf("platformId");
string chargePermissionId = jResp.StringOf("chargePermissionId");
string chargeId = jResp.StringOf("chargeId");
string creationTimestamp = jResp.StringOf("creationTimestamp");
string expirationTimestamp = jResp.StringOf("expirationTimestamp");
string storeId = jResp.StringOf("storeId");
string deliverySpecificationsAddressRestrictionsType = jResp.StringOf("deliverySpecifications.addressRestrictions.type");
string providerMetadataProviderReferenceId = jResp.StringOf("providerMetadata.providerReferenceId");
string releaseEnvironment = jResp.StringOf("releaseEnvironment");
int i = 0;
int count_i = jResp.SizeOfArray("paymentPreferences");
while (i < count_i) {
    jResp.I = i;
    paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("constraints");
while (i < count_i) {
    jResp.I = i;
    constraintId = jResp.StringOf("constraints[i].constraintId");
    description = jResp.StringOf("constraints[i].description");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.specialRestrictions");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("deliverySpecifications.specialRestrictions[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]");
    i = i + 1;
}