(PowerShell) Amazon Pay - Get Charge Permission

See more Amazon Pay Examples

Get Charge Permission to determine if this Charge Permission can be used to charge the buyer.

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/charge-permission.html#get-charge-permission

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

# Implements the following CURL command:

# curl "https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId"
# 	-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.
$privKey = New-Object Chilkat.PrivateKey
$success = $privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if ($success -eq $false) {
    $($privKey.LastErrorText)
    exit
}

# 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 -eq $false) {
    $($http.LastErrorText)
    exit
}

# 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"

$respStatusCode = 0

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.SetUrlVar("chargePermissionId","P21-1111111-1111111")
# 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/chargePermissions/{$chargePermissionId}",$sbResponseBody)
if ($success -eq $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 -ne 0) {
        $("Response Status Code = " + $respStatusCode)
        $("Response body:")
        $($http.LastResponseBody)
    }
    else {
        $($http.LastErrorText)
    }

    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("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 -ne 200) {
    $("Failed.")
    exit
}

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

# {
#     "chargePermissionId": "chargePermission-1",
#     "chargePermissionReferenceId": null,
#     "buyer": {
#         "buyerId": "buyerId",
#         "name": "name-1",
#         "email": "name@amazon.com",
#         "phoneNumber": "800-000-0000",
#         "primeMembershipTypes": null
#     },
#     "releaseEnvironment": "Live",
#     "shippingAddress":{  // Null for PayOnly product type
#         "name": "Work",
#         "addressLine1": "440 Terry Ave",
#         "addressLine2": "",
#         "addressLine3": "",
#         "city": "Seattle",
#         "county": "King",
#         "district": "Seattle",
#         "stateOrRegion": "WA",
#         "postalCode": "98121",
#         "countryCode": "US",
#         "phoneNumber": "800-000-0000"
#     },
#     "billingAddress":{  // Only available in EU or for PayOnly product type
#         "name": "Work",
#         "addressLine1": "440 Terry Ave",
#         "addressLine2": "",
#         "addressLine3": "",
#         "city": "Seattle",
#         "county": "King",
#         "district": "Seattle",
#         "stateOrRegion": "WA",
#         "postalCode": "98121",
#         "countryCode": "US",
#         "phoneNumber": "800-000-0000"
#     },
#     "paymentPreferences":[{
#         "paymentDescriptor": null
#     }],
#     "statusDetails":{
#         "state": "Chargeable",
#         "reasons":null,
#         "lastUpdatedTimestamp": "20190714T155300Z"
#     },
#     "creationTimestamp": "20190714T155300Z",
#     "expirationTimestamp": "20190715T155300Z",
#     "merchantMetadata":{
#         "merchantReferenceId": "123-77-876", 
#         "merchantStoreName": "AmazonTestStoreFront",
#         "noteToBuyer": "merchantNoteForBuyer",
#         "customInformation": "This is custom information"
#     },
#     "platformId": "SPId",
#     "limits": {
#         "amountLimit": {
#             "amount": "14.00",
#             "currencyCode": "USD"
#         },
#         "amountBalance": {
#             "amount": "14.00",
#             "currencyCode": "USD"
#         }
#     },
#     "presentmentCurrency": "USD"
# }

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

$chargePermissionId = $jResp.StringOf("chargePermissionId")
$chargePermissionReferenceId = $jResp.StringOf("chargePermissionReferenceId")
$buyerBuyerId = $jResp.StringOf("buyer.buyerId")
$buyerName = $jResp.StringOf("buyer.name")
$buyerEmail = $jResp.StringOf("buyer.email")
$buyerPhoneNumber = $jResp.StringOf("buyer.phoneNumber")
$buyerPrimeMembershipTypes = $jResp.StringOf("buyer.primeMembershipTypes")
$releaseEnvironment = $jResp.StringOf("releaseEnvironment")
$shippingAddressName = $jResp.StringOf("shippingAddress.name")
$shippingAddressAddressLine1 = $jResp.StringOf("shippingAddress.addressLine1")
$shippingAddressAddressLine2 = $jResp.StringOf("shippingAddress.addressLine2")
$shippingAddressAddressLine3 = $jResp.StringOf("shippingAddress.addressLine3")
$shippingAddressCity = $jResp.StringOf("shippingAddress.city")
$shippingAddressCounty = $jResp.StringOf("shippingAddress.county")
$shippingAddressDistrict = $jResp.StringOf("shippingAddress.district")
$shippingAddressStateOrRegion = $jResp.StringOf("shippingAddress.stateOrRegion")
$shippingAddressPostalCode = $jResp.StringOf("shippingAddress.postalCode")
$shippingAddressCountryCode = $jResp.StringOf("shippingAddress.countryCode")
$shippingAddressPhoneNumber = $jResp.StringOf("shippingAddress.phoneNumber")
$billingAddressName = $jResp.StringOf("billingAddress.name")
$billingAddressAddressLine1 = $jResp.StringOf("billingAddress.addressLine1")
$billingAddressAddressLine2 = $jResp.StringOf("billingAddress.addressLine2")
$billingAddressAddressLine3 = $jResp.StringOf("billingAddress.addressLine3")
$billingAddressCity = $jResp.StringOf("billingAddress.city")
$billingAddressCounty = $jResp.StringOf("billingAddress.county")
$billingAddressDistrict = $jResp.StringOf("billingAddress.district")
$billingAddressStateOrRegion = $jResp.StringOf("billingAddress.stateOrRegion")
$billingAddressPostalCode = $jResp.StringOf("billingAddress.postalCode")
$billingAddressCountryCode = $jResp.StringOf("billingAddress.countryCode")
$billingAddressPhoneNumber = $jResp.StringOf("billingAddress.phoneNumber")
$statusDetailsState = $jResp.StringOf("statusDetails.state")
$statusDetailsReasons = $jResp.StringOf("statusDetails.reasons")
$statusDetailsLastUpdatedTimestamp = $jResp.StringOf("statusDetails.lastUpdatedTimestamp")
$creationTimestamp = $jResp.StringOf("creationTimestamp")
$expirationTimestamp = $jResp.StringOf("expirationTimestamp")
$merchantMetadataMerchantReferenceId = $jResp.StringOf("merchantMetadata.merchantReferenceId")
$merchantMetadataMerchantStoreName = $jResp.StringOf("merchantMetadata.merchantStoreName")
$merchantMetadataNoteToBuyer = $jResp.StringOf("merchantMetadata.noteToBuyer")
$merchantMetadataCustomInformation = $jResp.StringOf("merchantMetadata.customInformation")
$platformId = $jResp.StringOf("platformId")
$limitsAmountLimitAmount = $jResp.StringOf("limits.amountLimit.amount")
$limitsAmountLimitCurrencyCode = $jResp.StringOf("limits.amountLimit.currencyCode")
$limitsAmountBalanceAmount = $jResp.StringOf("limits.amountBalance.amount")
$limitsAmountBalanceCurrencyCode = $jResp.StringOf("limits.amountBalance.currencyCode")
$presentmentCurrency = $jResp.StringOf("presentmentCurrency")
$i = 0
$count_i = $jResp.SizeOfArray("paymentPreferences")
while ($i -lt $count_i) {
    $jResp.I = $i
    $paymentDescriptor = $jResp.StringOf("paymentPreferences[i].paymentDescriptor")
    $i = $i + 1
}