(Perl) 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 Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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 = chilkat::CkPrivateKey->new();
$success = $privKey->LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if ($success == 0) {
    print $privKey->lastErrorText() . "\r\n";
    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 == 0) {
    print $http->lastErrorText() . "\r\n";
    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->put_Accept("application/json");

$respStatusCode = 0;

$sbResponseBody = chilkat::CkStringBuilder->new();
$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 == 0) {
    # If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    $respStatusCode = $http->get_LastStatus();
    if ($respStatusCode != 0) {
        print "Response Status Code = " . $respStatusCode . "\r\n";
        print "Response body:" . "\r\n";
        print $http->lastResponseBody() . "\r\n";
    }
    else {
        print $http->lastErrorText() . "\r\n";
    }

    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
# We expect a 200 status code for success.
# Note: Some Amazon Pay API calls return 200 for success, others return 201.
if ($respStatusCode != 200) {
    print "Failed." . "\r\n";
    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 < $count_i) {
    $jResp->put_I($i);
    $paymentDescriptor = $jResp->stringOf("paymentPreferences[i].paymentDescriptor");
    $i = $i + 1;
}