(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_PrivKey
string ls_PublicKeyId
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_ChargeId
string ls_ChargePermissionId
string ls_ChargeAmountAmount
string ls_ChargeAmountCurrencyCode
string ls_CaptureAmountAmount
string ls_CaptureAmountCurrencyCode
string ls_RefundedAmountAmount
string ls_RefundedAmountCurrencyCode
string ls_ConvertedAmount
string ls_ConversionRate
string ls_SoftDescriptor
string ls_MerchantMetadata
string ls_ProviderMetadataProviderReferenceId
string ls_StatusDetailsState
string ls_StatusDetailsReasonCode
string ls_StatusDetailsReasonDescription
string ls_StatusDetailsLastUpdatedTimestamp
string ls_CreationTimestamp
string ls_ExpirationTimestamp
string ls_ReleaseEnvironment

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("captureAmount.amount","14.00")
loo_Json.UpdateString("captureAmount.currencyCode","USD")
loo_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.
loo_PrivKey = create oleobject
// Use "Chilkat_9_5_0.PrivateKey" for versions of Chilkat < 10.0.0
li_rc = loo_PrivKey.ConnectToNewObject("Chilkat.PrivateKey")

li_Success = loo_PrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if li_Success = 0 then
    Write-Debug loo_PrivKey.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_PrivKey
    return
end if

// 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
ls_PublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
li_Success = loo_Http.SetAuthPrivateKey(ls_PublicKeyId,loo_PrivKey)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_PrivKey
    return
end if

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

loo_Http.Accept = "application/json"

li_Success = loo_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
loo_Resp = loo_Http.PostJson3("https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/capture","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_PrivKey
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

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

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode <> 200 then
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_Json
    destroy loo_PrivKey
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

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

ls_ChargeId = loo_JResp.StringOf("chargeId")
ls_ChargePermissionId = loo_JResp.StringOf("chargePermissionId")
ls_ChargeAmountAmount = loo_JResp.StringOf("chargeAmount.amount")
ls_ChargeAmountCurrencyCode = loo_JResp.StringOf("chargeAmount.currencyCode")
ls_CaptureAmountAmount = loo_JResp.StringOf("captureAmount.amount")
ls_CaptureAmountCurrencyCode = loo_JResp.StringOf("captureAmount.currencyCode")
ls_RefundedAmountAmount = loo_JResp.StringOf("refundedAmount.amount")
ls_RefundedAmountCurrencyCode = loo_JResp.StringOf("refundedAmount.currencyCode")
ls_ConvertedAmount = loo_JResp.StringOf("convertedAmount")
ls_ConversionRate = loo_JResp.StringOf("conversionRate")
ls_SoftDescriptor = loo_JResp.StringOf("softDescriptor")
ls_MerchantMetadata = loo_JResp.StringOf("merchantMetadata")
ls_ProviderMetadataProviderReferenceId = loo_JResp.StringOf("providerMetadata.providerReferenceId")
ls_StatusDetailsState = loo_JResp.StringOf("statusDetails.state")
ls_StatusDetailsReasonCode = loo_JResp.StringOf("statusDetails.reasonCode")
ls_StatusDetailsReasonDescription = loo_JResp.StringOf("statusDetails.reasonDescription")
ls_StatusDetailsLastUpdatedTimestamp = loo_JResp.StringOf("statusDetails.lastUpdatedTimestamp")
ls_CreationTimestamp = loo_JResp.StringOf("creationTimestamp")
ls_ExpirationTimestamp = loo_JResp.StringOf("expirationTimestamp")
ls_ReleaseEnvironment = loo_JResp.StringOf("releaseEnvironment")


destroy loo_Http
destroy loo_Json
destroy loo_PrivKey
destroy loo_SbResponseBody
destroy loo_JResp