(C#) Amazon Pay - Capture Charge

See more Amazon Pay Examples

Capture payment on a Charge in the Authorized state. A successful Capture will move the Charge from Authorized to Captured state.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

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

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Chilkat.Http http = new Chilkat.Http();
bool success;

// Implements the following CURL command:

// curl "https://pay-api.amazon.com/:version/charges/:chargeId/capture" \
// -X POST
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
// -d '{
//     "captureAmount": {
//         "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.

// {
//     "captureAmount": {
//         "amount": "14.00",
//         "currencyCode": "USD"
//     },
//     "softDescriptor": "Descriptor"
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("captureAmount.amount","14.00");
json.UpdateString("captureAmount.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.
Chilkat.PrivateKey privKey = new Chilkat.PrivateKey();
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if (success == false) {
    Debug.WriteLine(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
string publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = http.SetAuthPrivateKey(publicKeyId,privKey);
if (success == false) {
    Debug.WriteLine(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
// x-amz-pay-idempotency-key
// Authorization

http.Accept = "application/json";

success = http.SetUrlVar("chargeId","P21-1111111-1111111");

// To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
Chilkat.HttpResponse resp = http.PostJson3("https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/capture","application/json",json);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

// If the status code is not equal to 200, this will display error information.
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode != 200) {
    Debug.WriteLine("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": "Descriptor",
//      "merchantMetadata": null,
//      "providerMetadata": {
//          "providerReferenceId": null
//      },
//      "statusDetails":{
//          "state": "Captured",
//          "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

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