(Lianja) Amazon Pay - Get Charge

See more Amazon Pay Examples

Get Charge details such as charge amount and authorization state. Use this operation to determine if authorization or capture was successful.

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#get-charge

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// Implements the following CURL command:

// curl "https://pay-api.amazon.com/:version/charges/:chargeId"
//  -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
//  -H "x-amz-pay-date:20201012T235046Z"
//  -X GET

// 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.
loPrivKey = createobject("CkPrivateKey")
llSuccess = loPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if (llSuccess = .F.) then
    ? loPrivKey.LastErrorText
    release loHttp
    release loPrivKey
    return
endif

// 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
lcPublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
llSuccess = loHttp.SetAuthPrivateKey(lcPublicKeyId,loPrivKey)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loPrivKey
    return
endif

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

loHttp.Accept = "application/json"

lnRespStatusCode = 0

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.SetUrlVar("chargeId","P21-1111111-1111111")
// To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
llSuccess = loHttp.QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}",loSbResponseBody)
if (llSuccess = .F.) then
    // If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    lnRespStatusCode = loHttp.LastStatus
    if (lnRespStatusCode <> 0) then
        ? "Response Status Code = " + str(lnRespStatusCode)
        ? "Response body:"
        ? loHttp.LastResponseBody
    else
        ? loHttp.LastErrorText
    endif

    release loHttp
    release loPrivKey
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
// We expect a 200 status code for success.
// Note: Some Amazon Pay API calls return 200 for success, others return 201.
if (lnRespStatusCode <> 200) then
    ? "Failed."
    release loHttp
    release loPrivKey
    release loSbResponseBody
    release loJResp
    return
endif

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

lcChargeId = loJResp.StringOf("chargeId")
lcChargePermissionId = loJResp.StringOf("chargePermissionId")
lcChargeAmountAmount = loJResp.StringOf("chargeAmount.amount")
lcChargeAmountCurrencyCode = loJResp.StringOf("chargeAmount.currencyCode")
lcCaptureAmountAmount = loJResp.StringOf("captureAmount.amount")
lcCaptureAmountCurrencyCode = loJResp.StringOf("captureAmount.currencyCode")
lcRefundedAmountAmount = loJResp.StringOf("refundedAmount.amount")
lcRefundedAmountCurrencyCode = loJResp.StringOf("refundedAmount.currencyCode")
lcConvertedAmount = loJResp.StringOf("convertedAmount")
lcConversionRate = loJResp.StringOf("conversionRate")
lcSoftDescriptor = loJResp.StringOf("softDescriptor")
lcMerchantMetadata = loJResp.StringOf("merchantMetadata")
lcProviderMetadataProviderReferenceId = loJResp.StringOf("providerMetadata.providerReferenceId")
lcStatusDetailsState = loJResp.StringOf("statusDetails.state")
lcStatusDetailsReasonCode = loJResp.StringOf("statusDetails.reasonCode")
lcStatusDetailsReasonDescription = loJResp.StringOf("statusDetails.reasonDescription")
lcStatusDetailsLastUpdatedTimestamp = loJResp.StringOf("statusDetails.lastUpdatedTimestamp")
lcCreationTimestamp = loJResp.StringOf("creationTimestamp")
lcExpirationTimestamp = loJResp.StringOf("expirationTimestamp")
lcReleaseEnvironment = loJResp.StringOf("releaseEnvironment")


release loHttp
release loPrivKey
release loSbResponseBody
release loJResp