(Objective-C) Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments.

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

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/charges/:chargeId/cancel" \
// -X DELETE
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
//     "cancellationReason": "REASON DESCRIPTION"
// }'

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

// {
//   "cancellationReason": "REASON DESCRIPTION"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"cancellationReason" value: @"REASON DESCRIPTION"];

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 chargeId here:
success = [http SetUrlVar: @"chargeId" value: @"bd504926-f659-4ad7-a1a9-9a747aaf5275"];
// 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/charges/{$chargeId}/cancel" 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)

// {
//   "chargeId": "P21-1111111-1111111-C111111",
//   "chargePermissionId": "P21-1111111-1111111",
//   "chargeAmount": {
//     "amount": "14.00",
//     "currencyCode": "USD"
//   },
//   "captureAmount": {
//     "amount": "14.00",
//     "currencyCode": "USD"
//   },
//   "refundedAmount": {
//     "amount": "0.00",
//     "currencyCode": "USD"
//   },
//   "convertedAmount": "14.00",
//   "conversionRate": "1.00",
//   "softDescriptor": "SOFT DESCRIPTOR",
//   "merchantMetadata": null,
//   "providerMetadata": {
//     "providerReferenceId": null
//   },
//   "statusDetails": {
//     "state": "Canceled",
//     "reasonCode": null,
//     "reasonDescription": null,
//     "lastUpdatedTimestamp": "20190714T155300Z"
//   },
//   "creationTimestamp": "20190714T155300Z",
//   "expirationTimestamp": "20190715T155300Z",
//   "releaseEnvironment": "Sandbox"
// }

// 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 *chargeId = [jResp StringOf: @"chargeId"];
NSString *chargePermissionId = [jResp StringOf: @"chargePermissionId"];
NSString *chargeAmountAmount = [jResp StringOf: @"chargeAmount.amount"];
NSString *chargeAmountCurrencyCode = [jResp StringOf: @"chargeAmount.currencyCode"];
NSString *captureAmountAmount = [jResp StringOf: @"captureAmount.amount"];
NSString *captureAmountCurrencyCode = [jResp StringOf: @"captureAmount.currencyCode"];
NSString *refundedAmountAmount = [jResp StringOf: @"refundedAmount.amount"];
NSString *refundedAmountCurrencyCode = [jResp StringOf: @"refundedAmount.currencyCode"];
NSString *convertedAmount = [jResp StringOf: @"convertedAmount"];
NSString *conversionRate = [jResp StringOf: @"conversionRate"];
NSString *softDescriptor = [jResp StringOf: @"softDescriptor"];
NSString *merchantMetadata = [jResp StringOf: @"merchantMetadata"];
NSString *providerMetadataProviderReferenceId = [jResp StringOf: @"providerMetadata.providerReferenceId"];
NSString *statusDetailsState = [jResp StringOf: @"statusDetails.state"];
NSString *statusDetailsReasonCode = [jResp StringOf: @"statusDetails.reasonCode"];
NSString *statusDetailsReasonDescription = [jResp StringOf: @"statusDetails.reasonDescription"];
NSString *statusDetailsLastUpdatedTimestamp = [jResp StringOf: @"statusDetails.lastUpdatedTimestamp"];
NSString *creationTimestamp = [jResp StringOf: @"creationTimestamp"];
NSString *expirationTimestamp = [jResp StringOf: @"expirationTimestamp"];
NSString *releaseEnvironment = [jResp StringOf: @"releaseEnvironment"];