(Swift 3,4,5...) Amazon Pay - Update Checkout Session

See more Amazon Pay Examples

Update the Checkout Session with transaction details.

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

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    let http = CkoHttp()!
    var success: Bool

    // Implements the following CURL command:

    // curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId" \
    // -X PATCH
    // -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
    // -H "x-amz-pay-date:20201012T235046Z"
    // -d '{
    //     "webCheckoutDetails": {
    //         "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
    //     },
    //     "paymentDetails": {
    //         "paymentIntent": "AuthorizeWithCapture",
    //         "canHandlePendingAuthorization":false,
    //         "softDescriptor": "Descriptor",
    //         "chargeAmount": {
    //             "amount": "1",
    //             "currencyCode": "USD"
    //         }
    //      },
    //     "merchantMetadata": {
    //         "merchantReferenceId": "Merchant reference ID",
    //         "merchantStoreName": "Merchant store name",
    //         "noteToBuyer": "Note to buyer",
    //         "customInformation": "Custom information"
    //     }
    // }'

    // 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": {
    //     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
    //   },
    //   "paymentDetails": {
    //     "paymentIntent": "AuthorizeWithCapture",
    //     "canHandlePendingAuthorization": false,
    //     "softDescriptor": "Descriptor",
    //     "chargeAmount": {
    //       "amount": "1",
    //       "currencyCode": "USD"
    //     }
    //   },
    //   "merchantMetadata": {
    //     "merchantReferenceId": "Merchant reference ID",
    //     "merchantStoreName": "Merchant store name",
    //     "noteToBuyer": "Note to buyer",
    //     "customInformation": "Custom information"
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("webCheckoutDetails.checkoutResultReturnUrl", value: "https://a.com/merchant-confirm-page")
    json.update("paymentDetails.paymentIntent", value: "AuthorizeWithCapture")
    json.updateBool("paymentDetails.canHandlePendingAuthorization", value: false)
    json.update("paymentDetails.softDescriptor", value: "Descriptor")
    json.update("paymentDetails.chargeAmount.amount", value: "1")
    json.update("paymentDetails.chargeAmount.currencyCode", value: "USD")
    json.update("merchantMetadata.merchantReferenceId", value: "Merchant reference ID")
    json.update("merchantMetadata.merchantStoreName", value: "Merchant store name")
    json.update("merchantMetadata.noteToBuyer", value: "Note to buyer")
    json.update("merchantMetadata.customInformation", value: "Custom information")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    // 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 privKey = CkoPrivateKey()!
    success = privKey.loadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
    if success == false {
        print("\(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
    var publicKeyId: String? = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
    success = http.setAuthPrivateKey(publicKeyId, privKey: privKey)
    if success == false {
        print("\(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"

    success = http.setUrlVar("sessionId", value: "62b7d028-6c7c-4a43-b077-3897dff27c5b")
    // To use the live system, replace "sandbox" with "live" in the URL passed to PTextSb.
    // Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
    var resp: CkoHttpResponse? = http.pTextSb("PATCH", url: "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    // If the status code is not equal to 200, this will display error information.
    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode != 200 {

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

        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "checkoutSessionId": "ada3f397-7d4b-4a55-abac-786685c02d8b",
    //   "webCheckoutDetails": {
    //     "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
    //     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
    //     "checkoutCancelUrl": null,
    //     "amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
    //   },
    //   "productType": "PayAndShip",
    //   "paymentDetails": {
    //     "paymentIntent": "AuthorizeWithCapture",
    //     "canHandlePendingAuthorization": false,
    //     "chargeAmount": {
    //       "amount": "1",
    //       "currencyCode": "USD"
    //     },
    //     "totalOrderAmount": null,
    //     "softDescriptor": "Descriptor",
    //     "presentmentCurrency": "USD",
    //     "allowOvercharge": null,
    //     "extendExpiration": null
    //   },
    //   "merchantMetadata": {
    //     "merchantReferenceId": "Merchant reference ID",
    //     "merchantStoreName": "Merchant store name",
    //     "noteToBuyer": "Note to buyer",
    //     "customInformation": "Custom information"
    //   },
    //   "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": "20191015T195703Z"
    //   },
    //   "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": [
    //   ],
    //   "creationTimestamp": "20191015T195655Z",
    //   "expirationTimestamp": "20191016T195655Z",
    //   "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

    var paymentDescriptor: String?
    var strVal: String?

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

    i = 0
    count_i = jResp.size(ofArray: "constraints").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "deliverySpecifications.specialRestrictions").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "deliverySpecifications.specialRestrictions[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions").intValue
    while i < count_i {
        jResp.i = i
        strVal = jResp.string(of: "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
        i = i + 1
    }


}