Dart Requires Chilkat v11.0.0+
Dart
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 Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
final http = CkHttp();
// 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
// }
final json = CkJsonObject();
json.updateString('closureReason', 'No more charges required');
json.updateBool('cancelPendingCharges', false);
final sbRequestBody = CkStringBuilder();
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.
final privKey = CkPrivateKey();
try {
privKey.loadPemFile('C:/someDir/myAmazonPayPrivateKey.pem');
} on ChilkatException catch (e) {
print(e.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
final publicKeyId = 'SANDBOX-AHEGSJCM3L2S637RBGABLAFW';
try {
http.setAuthPrivateKey(publicKeyId, privKey);
} on ChilkatException catch (e) {
print(e.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';
// Use the actual chargePermissionId here:
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
final resp = CkHttpResponse();
try {
http.httpSb('DELETE', 'https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{\$chargePermissionId}/close', sbRequestBody, 'utf-8', 'application/json', resp);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
final sbResponseBody = CkStringBuilder();
resp.getBodySb(sbResponseBody);
final jResp = CkJsonObject();
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());
final respStatusCode = resp.statusCode;
print('Response Status Code = $respStatusCode');
if (respStatusCode != 200) {
print('Failed.');
return;
}
// 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
var paymentDescriptor = '';
var reasonCode = '';
var reasonDescription = '';
final chargePermissionId = jResp.stringOf('chargePermissionId');
final chargePermissionReferenceId = jResp.stringOf('chargePermissionReferenceId');
final buyerBuyerId = jResp.stringOf('buyer.buyerId');
final buyerName = jResp.stringOf('buyer.name');
final buyerEmail = jResp.stringOf('buyer.email');
final buyerPhoneNumber = jResp.stringOf('buyer.phoneNumber');
final buyerPrimeMembershipTypes = jResp.stringOf('buyer.primeMembershipTypes');
final releaseEnvironment = jResp.stringOf('releaseEnvironment');
final shippingAddressName = jResp.stringOf('shippingAddress.name');
final shippingAddressAddressLine1 = jResp.stringOf('shippingAddress.addressLine1');
final shippingAddressAddressLine2 = jResp.stringOf('shippingAddress.addressLine2');
final shippingAddressAddressLine3 = jResp.stringOf('shippingAddress.addressLine3');
final shippingAddressCity = jResp.stringOf('shippingAddress.city');
final shippingAddressCounty = jResp.stringOf('shippingAddress.county');
final shippingAddressDistrict = jResp.stringOf('shippingAddress.district');
final shippingAddressStateOrRegion = jResp.stringOf('shippingAddress.stateOrRegion');
final shippingAddressPostalCode = jResp.stringOf('shippingAddress.postalCode');
final shippingAddressCountryCode = jResp.stringOf('shippingAddress.countryCode');
final shippingAddressPhoneNumber = jResp.stringOf('shippingAddress.phoneNumber');
final billingAddressName = jResp.stringOf('billingAddress.name');
final billingAddressAddressLine1 = jResp.stringOf('billingAddress.addressLine1');
final billingAddressAddressLine2 = jResp.stringOf('billingAddress.addressLine2');
final billingAddressAddressLine3 = jResp.stringOf('billingAddress.addressLine3');
final billingAddressCity = jResp.stringOf('billingAddress.city');
final billingAddressCounty = jResp.stringOf('billingAddress.county');
final billingAddressDistrict = jResp.stringOf('billingAddress.district');
final billingAddressStateOrRegion = jResp.stringOf('billingAddress.stateOrRegion');
final billingAddressPostalCode = jResp.stringOf('billingAddress.postalCode');
final billingAddressCountryCode = jResp.stringOf('billingAddress.countryCode');
final billingAddressPhoneNumber = jResp.stringOf('billingAddress.phoneNumber');
final statusDetailsState = jResp.stringOf('statusDetails.state');
final statusDetailsLastUpdatedTimestamp = jResp.stringOf('statusDetails.lastUpdatedTimestamp');
final creationTimestamp = jResp.stringOf('creationTimestamp');
final expirationTimestamp = jResp.stringOf('expirationTimestamp');
final merchantMetadataMerchantReferenceId = jResp.stringOf('merchantMetadata.merchantReferenceId');
final merchantMetadataMerchantStoreName = jResp.stringOf('merchantMetadata.merchantStoreName');
final merchantMetadataNoteToBuyer = jResp.stringOf('merchantMetadata.noteToBuyer');
final merchantMetadataCustomInformation = jResp.stringOf('merchantMetadata.customInformation');
final platformId = jResp.stringOf('platformId');
final limitsAmountLimitAmount = jResp.stringOf('limits.amountLimit.amount');
final limitsAmountLimitCurrencyCode = jResp.stringOf('limits.amountLimit.currencyCode');
final limitsAmountBalanceAmount = jResp.stringOf('limits.amountBalance.amount');
final limitsAmountBalanceCurrencyCode = jResp.stringOf('limits.amountBalance.currencyCode');
final presentmentCurrency = jResp.stringOf('presentmentCurrency');
var i = 0;
var countI = jResp.sizeOfArray('paymentPreferences');
while (i < countI) {
jResp.i = i;
paymentDescriptor = jResp.stringOf('paymentPreferences[i].paymentDescriptor');
i++;
}
i = 0;
countI = jResp.sizeOfArray('statusDetails.reasons');
while (i < countI) {
jResp.i = i;
reasonCode = jResp.stringOf('statusDetails.reasons[i].reasonCode');
reasonDescription = jResp.stringOf('statusDetails.reasons[i].reasonDescription');
i++;
}
}