(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

json = Chilkat::CkJsonObject.new()
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.
privKey = Chilkat::CkPrivateKey.new()
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if (success == false)
    print privKey.lastErrorText() + "\n";
    exit
end

# 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
publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

# 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.put_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
# resp is a CkHttpResponse
resp = http.PostJson3("https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/capture","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

# If the status code is not equal to 200, this will display error information.
print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Failed." + "\n";

    exit
end

# 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

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