(Excel) Amazon Pay - Complete Checkout Session

See more Amazon Pay Examples

Complete Checkout Session after the buyer returns to checkoutResultReturnUrl to finalize the paymentIntent.

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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Implements the following CURL command:

' curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId/complete" \
' -X POST
' -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
' -H "x-amz-pay-date:20201012T235046Z"
' -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
' -d '{
'     "chargeAmount": {
'         "amount": "14.00",
'         "currencyCode": "USD"
'     }
' }'

' 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.

' {
'   "chargeAmount": {
'     "amount": "14.00",
'     "currencyCode": "USD"
'   }
' }

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
success = json.UpdateString("chargeAmount.amount","14.00")
success = json.UpdateString("chargeAmount.currencyCode","USD")

' 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.
Dim privKey As Chilkat.PrivateKey
Set privKey = Chilkat.NewPrivateKey
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If (success = False) Then
    Debug.Print privKey.LastErrorText
    Exit Sub
End If

' 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

publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' 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 PTextSb.
' Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
success = http.SetUrlVar("sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b")

Set resp = http.PostJson3("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}/complete","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

' If the status code is not equal to 200, this will display error information.
Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode <> 200) Then

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

    ' Another sample failure response (status code = 422)
    ' 	{
    ' 	  "reasonCode": "InvalidCheckoutSessionStatus",
    ' 	  "message": "You tried to call an operation on a Checkout Session that is in a state where that operation is not allowed"
    ' 	}

    Debug.Print "Failed."

    Exit Sub
End If

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

' {
'   "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
'   "webCheckoutDetails": null,
'   "chargePermissionType": "OneTime",
'   "recurringMetadata": null,
'   "productType": null,
'   "paymentDetails": null,
'   "merchantMetadata": null,
'   "supplementaryData": null,
'   "buyer": null,
'   "billingAddress": null,
'   "paymentPreferences": [
'     null
'   ],
'   "statusDetails": {
'     "state": "Completed",
'     "reasonCode": null,
'     "reasonDescription": null,
'     "lastUpdatedTimestamp": "20191015T204327Z"
'   },
'   "shippingAddress": null,
'   "platformId": null,
'   "chargePermissionId": "S01-5105180-3221187",
'   "chargeId": "S01-5105180-3221187-C056351",
'   "constraints": [
'     null
'   ],
'   "creationTimestamp": "20191015T204313Z",
'   "expirationTimestamp": null,
'   "storeId": null,
'   "deliverySpecifications": null,
'   "providerMetadata": null,
'   "releaseEnvironment": null
' }

' Sample code for parsing the JSON response...
' Use the following online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON


checkoutSessionId = jResp.StringOf("checkoutSessionId")

webCheckoutDetails = jResp.StringOf("webCheckoutDetails")

chargePermissionType = jResp.StringOf("chargePermissionType")

recurringMetadata = jResp.StringOf("recurringMetadata")

productType = jResp.StringOf("productType")

paymentDetails = jResp.StringOf("paymentDetails")

merchantMetadata = jResp.StringOf("merchantMetadata")

supplementaryData = jResp.StringOf("supplementaryData")

buyer = jResp.StringOf("buyer")

billingAddress = jResp.StringOf("billingAddress")

statusDetailsState = jResp.StringOf("statusDetails.state")

statusDetailsReasonCode = jResp.StringOf("statusDetails.reasonCode")

statusDetailsReasonDescription = jResp.StringOf("statusDetails.reasonDescription")

statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp")

shippingAddress = jResp.StringOf("shippingAddress")

platformId = jResp.StringOf("platformId")

chargePermissionId = jResp.StringOf("chargePermissionId")

chargeId = jResp.StringOf("chargeId")

creationTimestamp = jResp.StringOf("creationTimestamp")

expirationTimestamp = jResp.StringOf("expirationTimestamp")

storeId = jResp.StringOf("storeId")

deliverySpecifications = jResp.StringOf("deliverySpecifications")

providerMetadata = jResp.StringOf("providerMetadata")

releaseEnvironment = jResp.StringOf("releaseEnvironment")

i = 0

count_i = jResp.SizeOfArray("paymentPreferences")
Do While i < count_i
    jResp.I = i
    nullVal = jResp.IsNullOf("paymentPreferences[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("constraints")
Do While i < count_i
    jResp.I = i
    nullVal = jResp.IsNullOf("constraints[i]")
    i = i + 1
Loop