Dart Requires Chilkat v11.0.0+

Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments. Dart

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

  final json = CkJsonObject();
  json.updateString('cancellationReason', 'REASON DESCRIPTION');

  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.
  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 chargeId here:
  http.setUrlVar('chargeId', 'bd504926-f659-4ad7-a1a9-9a747aaf5275');
  // 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/charges/{\$chargeId}/cancel', 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)

  // {
  //   "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

  final chargeId = jResp.stringOf('chargeId');
  final chargePermissionId = jResp.stringOf('chargePermissionId');
  final chargeAmountAmount = jResp.stringOf('chargeAmount.amount');
  final chargeAmountCurrencyCode = jResp.stringOf('chargeAmount.currencyCode');
  final captureAmountAmount = jResp.stringOf('captureAmount.amount');
  final captureAmountCurrencyCode = jResp.stringOf('captureAmount.currencyCode');
  final refundedAmountAmount = jResp.stringOf('refundedAmount.amount');
  final refundedAmountCurrencyCode = jResp.stringOf('refundedAmount.currencyCode');
  final convertedAmount = jResp.stringOf('convertedAmount');
  final conversionRate = jResp.stringOf('conversionRate');
  final softDescriptor = jResp.stringOf('softDescriptor');
  final merchantMetadata = jResp.stringOf('merchantMetadata');
  final providerMetadataProviderReferenceId = jResp.stringOf('providerMetadata.providerReferenceId');
  final statusDetailsState = jResp.stringOf('statusDetails.state');
  final statusDetailsReasonCode = jResp.stringOf('statusDetails.reasonCode');
  final statusDetailsReasonDescription = jResp.stringOf('statusDetails.reasonDescription');
  final statusDetailsLastUpdatedTimestamp = jResp.stringOf('statusDetails.lastUpdatedTimestamp');
  final creationTimestamp = jResp.stringOf('creationTimestamp');
  final expirationTimestamp = jResp.stringOf('expirationTimestamp');
  final releaseEnvironment = jResp.stringOf('releaseEnvironment');
}