PHP ActiveX Requires Chilkat v11.0.0+
PHP ActiveX
Amazon Pay - Close Charge Permission
See more Amazon Pay Examples
Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.Chilkat PHP ActiveX Downloads
<?php
$success = 0;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat.Http");
// Implements the following CURL command:
// curl "https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId/close" \
// -X DELETE
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
// "closureReason": "No more charges required",
// "cancelPendingCharges": false
// }'
// 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.
// {
// "closureReason": "No more charges required",
// "cancelPendingCharges": false
// }
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('closureReason','No more charges required');
$json->UpdateBool('cancelPendingCharges',0);
$sbRequestBody = new COM("Chilkat.StringBuilder");
$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.
$privKey = new COM("Chilkat.PrivateKey");
$success = $privKey->LoadPemFile('C:/someDir/myAmazonPayPrivateKey.pem');
if ($success == 0) {
print $privKey->LastErrorText . "\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 . "\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->Accept = 'application/json';
// Use the actual chargePermissionId here:
$success = $http->SetUrlVar('chargePermissionId','P21-1111111-1111111');
// To use the live system, replace "sandbox" with "live" in the URL passed to HttpSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
$resp = new COM("Chilkat.HttpResponse");
$success = $http->HttpSb('DELETE','https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close',$sbRequestBody,'utf-8','application/json',$resp);
if ($success == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
// If the status code is not equal to 200, this will display error information.
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode != 200) {
print 'Failed.' . "\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": "Closed",
// "reasons":
// [{
// "reasonCode": null,
// "reasonDescription": 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');
$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->I = $i;
$paymentDescriptor = $jResp->stringOf('paymentPreferences[i].paymentDescriptor');
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('statusDetails.reasons');
while ($i < $count_i) {
$jResp->I = $i;
$reasonCode = $jResp->stringOf('statusDetails.reasons[i].reasonCode');
$reasonDescription = $jResp->stringOf('statusDetails.reasons[i].reasonDescription');
$i = $i + 1;
}
?>