Dart Requires Chilkat v11.0.0+

Amazon Pay - Create Refund

See more Amazon Pay Examples

Initiate a full or partial refund for a charge. 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/refunds/" \
  // -X POST
  // -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
  // -H "x-amz-pay-date:20201012T235046Z"
  // -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
  // -d '{
  //     "chargeId": "CHARGE_ID",
  //     "refundAmount": {
  //         "amount": "14.00",
  //         "currencyCode": "USD"
  //     },
  //     "softDescriptor": "Descriptor"
  // }'

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

  // {
  //     "chargeId": "CHARGE_ID",
  //     "refundAmount": {
  //         "amount": "14.00",
  //         "currencyCode": "USD"
  //     },
  //     "softDescriptor": "Descriptor"
  // }

  final json = CkJsonObject();
  json.updateString('chargeId', 'CHARGE_ID');
  json.updateString('refundAmount.amount', '14.00');
  json.updateString('refundAmount.currencyCode', 'USD');
  json.updateString('softDescriptor', 'Descriptor');

  // 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
  // x-amz-pay-idempotency-key
  // Authorization

  http.accept = 'application/json';

  // To use the live system, replace "sandbox" with "live" in the URL passed to HttpJson.
  // 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.httpJson('POST', 'https://pay-api.amazon.eu/sandbox/v2/refunds/', json, '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 201, this will display error information.
  print('Response Body:');
  print(jResp.emit());

  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode != 201) {
    print('Failed.');
    return;
  }

  // Sample JSON response:
  // (Sample code for parsing the JSON response is shown below)

  // {
  //      "refundId": "S01-5105180-3221187-R022311",
  //      "chargeId": "S01-5105180-3221187-C056351",
  //      "refundAmount": {
  //          "amount": "14.00",
  //          "currencyCode": "USD"
  //      },
  //      "softDescriptor": "Descriptor",
  //      "creationTimestamp": "20190714T155300Z",
  //      "statusDetails": {
  //          "state": "RefundInitiated",
  //          "reasonCode": null,
  //          "reasonDescription": null,
  //          "lastUpdatedTimestamp": "20190714T155300Z"
  //      },
  //      "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 refundId = jResp.stringOf('refundId');
  final chargeId = jResp.stringOf('chargeId');
  final refundAmountAmount = jResp.stringOf('refundAmount.amount');
  final refundAmountCurrencyCode = jResp.stringOf('refundAmount.currencyCode');
  final softDescriptor = jResp.stringOf('softDescriptor');
  final creationTimestamp = jResp.stringOf('creationTimestamp');
  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 releaseEnvironment = jResp.stringOf('releaseEnvironment');
}