(Objective-C) Amazon Pay - Create Checkout Session

See more Amazon Pay Examples

Create a new Amazon Pay Checkout Session.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

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

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoPrivateKey.h>
#import <NSString.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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/" \
// -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": {}
//       }
//     }
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"webCheckoutDetails.checkoutReviewReturnUrl" value: @"https://a.com/merchant-review-page"];
// Make sure to use your storeId here:
[json UpdateString: @"storeId" value: @"amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId"];
int i = 0;
json.I = [NSNumber numberWithInt: i];
[json UpdateString: @"scopes[i]" value: @"name"];
i = i + 1;
json.I = [NSNumber numberWithInt: i];
[json UpdateString: @"scopes[i]" value: @"email"];
i = i + 1;
json.I = [NSNumber numberWithInt: i];
[json UpdateString: @"scopes[i]" value: @"phoneNumber"];
i = i + 1;
json.I = [NSNumber numberWithInt: i];
[json UpdateString: @"scopes[i]" value: @"billingAddress"];
[json UpdateString: @"deliverySpecifications.specialRestrictions[0]" value: @"RestrictPOBoxes"];
[json UpdateString: @"deliverySpecifications.addressRestrictions.type" value: @"Allowed"];
[json UpdateString: @"deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]" value: @"WA"];
[json UpdateString: @"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]" value: @"95050"];
[json UpdateString: @"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]" value: @"93405"];
[json UpdateString: @"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]" value: @"72046"];
[json UpdateString: @"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]" value: @"72047"];
[json UpdateString: @"deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]" value: @"AP"];
[json UpdateNewObject: @"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.
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
// x-amz-pay-idempotency-key
// Authorization

http.Accept = @"application/json";

// To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
CkoHttpResponse *resp = [http PostJson3: @"https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

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

// If the status code is not equal to 201, this will display error information.
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode != 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."
    // 	}

    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
//   },
//   "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

BOOL nullVal;
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 *productType = [jResp StringOf: @"productType"];
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 *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 *buyer = [jResp StringOf: @"buyer"];
NSString *billingAddress = [jResp StringOf: @"billingAddress"];
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 *shippingAddress = [jResp StringOf: @"shippingAddress"];
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"];
i = 0;
int count_i = [[jResp SizeOfArray: @"paymentPreferences"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    nullVal = [jResp IsNullOf: @"paymentPreferences[i]"];
    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;
}