(Objective-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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoPrivateKey.h>
#import <NSString.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
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.
CkoPrivateKey *privKey = [[CkoPrivateKey alloc] init];
success = [privKey LoadPemFile: @"C:/someDir/myAmazonPayPrivateKey.pem"];
if (success == NO) {
    NSLog(@"%@",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
NSString *publicKeyId = @"SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = [http SetAuthPrivateKey: publicKeyId privKey: privKey];
if (success == NO) {
    NSLog(@"%@",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;

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http SetUrlVar: @"sessionId" value: @"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}" sbContent: sbResponseBody];
if (success == NO) {
    // If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    respStatusCode = [http.LastStatus intValue];
    if (respStatusCode != 0) {
        NSLog(@"%@%d",@"Response Status Code = ",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'"}

        NSLog(@"%@",@"Response body:");
        NSLog(@"%@",http.LastResponseBody);
    }
    else {
        NSLog(@"%@",http.LastErrorText);
    }

    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",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) {
    NSLog(@"%@",@"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

NSString *paymentDescriptor = 0;
NSString *constraintId = 0;
NSString *description = 0;
NSString *strVal = 0;

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

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

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

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

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

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

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