(Objective-C) 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.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/charge-permission.html#close-charge-permission

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoPrivateKey.h>
#import <NSString.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"closureReason" value: @"No more charges required"];
[json UpdateBool: @"cancelPendingCharges" value: NO];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[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.
CkoPrivateKey *privKey = [[CkoPrivateKey alloc] init];
success = [privKey LoadPemFile: @"C:/someDir/myAmazonPayPrivateKey.pem"];
if (success == NO) {
    NSLog(@"%@",privKey.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
NSString *publicKeyId = @"SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = [http SetAuthPrivateKey: publicKeyId privKey: privKey];
if (success == NO) {
    NSLog(@"%@",http.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:
success = [http SetUrlVar: @"chargePermissionId" value: @"CHARGE_PERMISSION_ID"];
// 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
CkoHttpResponse *resp = [http PTextSb: @"DELETE" url: @"https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

// If the status code is not equal to 200, this will display error information.
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode != 200) {
    NSLog(@"%@",@"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

NSString *paymentDescriptor = 0;
NSString *reasonCode = 0;
NSString *reasonDescription = 0;

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

i = 0;
count_i = [[jResp SizeOfArray: @"statusDetails.reasons"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    reasonCode = [jResp StringOf: @"statusDetails.reasons[i].reasonCode"];
    reasonDescription = [jResp StringOf: @"statusDetails.reasons[i].reasonDescription"];
    i = i + 1;
}