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

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vPrivKey
    Handle hoPrivKey
    String sPublicKeyId
    Integer iRespStatusCode
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    String sChargeId
    String sChargePermissionId
    String sChargeAmountAmount
    String sChargeAmountCurrencyCode
    String sCaptureAmountAmount
    String sCaptureAmountCurrencyCode
    String sRefundedAmountAmount
    String sRefundedAmountCurrencyCode
    String sConvertedAmount
    String sConversionRate
    String sSoftDescriptor
    String sMerchantMetadata
    String sProviderMetadataProviderReferenceId
    String sStatusDetailsState
    String sStatusDetailsReasonCode
    String sStatusDetailsReasonDescription
    String sStatusDetailsLastUpdatedTimestamp
    String sCreationTimestamp
    String sExpirationTimestamp
    String sReleaseEnvironment
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // 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.
    Get Create (RefClass(cComChilkatPrivateKey)) To hoPrivKey
    If (Not(IsComObjectCreated(hoPrivKey))) Begin
        Send CreateComObject of hoPrivKey
    End
    Get ComLoadPemFile Of hoPrivKey "C:/someDir/myAmazonPayPrivateKey.pem" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPrivKey To sTemp1
        Showln sTemp1
        Procedure_Return
    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
    Move "SANDBOX-AHEGSJCM3L2S637RBGABLAFW" To sPublicKeyId
    Get pvComObject of hoPrivKey to vPrivKey
    Get ComSetAuthPrivateKey Of hoHttp sPublicKeyId vPrivKey To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    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
    // Authorization

    Set ComAccept Of hoHttp To "application/json"

    Move 0 To iRespStatusCode

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get ComSetUrlVar Of hoHttp "chargeId" "P21-1111111-1111111" To iSuccess
    // 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
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        // If the LastStatus is not equal to 0, then we received a response, but it was an error response.
        Get ComLastStatus Of hoHttp To iRespStatusCode
        If (iRespStatusCode <> 0) Begin
            Showln "Response Status Code = " iRespStatusCode
            Showln "Response body:"
            Get ComLastResponseBody Of hoHttp To sTemp1
            Showln sTemp1
        End
        Else Begin
            Get ComLastErrorText Of hoHttp To sTemp1
            Showln sTemp1
        End

        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    // We expect a 200 status code for success.
    // Note: Some Amazon Pay API calls return 200 for success, others return 201.
    If (iRespStatusCode <> 200) Begin
        Showln "Failed."
        Procedure_Return
    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

    Get ComStringOf Of hoJResp "chargeId" To sChargeId
    Get ComStringOf Of hoJResp "chargePermissionId" To sChargePermissionId
    Get ComStringOf Of hoJResp "chargeAmount.amount" To sChargeAmountAmount
    Get ComStringOf Of hoJResp "chargeAmount.currencyCode" To sChargeAmountCurrencyCode
    Get ComStringOf Of hoJResp "captureAmount.amount" To sCaptureAmountAmount
    Get ComStringOf Of hoJResp "captureAmount.currencyCode" To sCaptureAmountCurrencyCode
    Get ComStringOf Of hoJResp "refundedAmount.amount" To sRefundedAmountAmount
    Get ComStringOf Of hoJResp "refundedAmount.currencyCode" To sRefundedAmountCurrencyCode
    Get ComStringOf Of hoJResp "convertedAmount" To sConvertedAmount
    Get ComStringOf Of hoJResp "conversionRate" To sConversionRate
    Get ComStringOf Of hoJResp "softDescriptor" To sSoftDescriptor
    Get ComStringOf Of hoJResp "merchantMetadata" To sMerchantMetadata
    Get ComStringOf Of hoJResp "providerMetadata.providerReferenceId" To sProviderMetadataProviderReferenceId
    Get ComStringOf Of hoJResp "statusDetails.state" To sStatusDetailsState
    Get ComStringOf Of hoJResp "statusDetails.reasonCode" To sStatusDetailsReasonCode
    Get ComStringOf Of hoJResp "statusDetails.reasonDescription" To sStatusDetailsReasonDescription
    Get ComStringOf Of hoJResp "statusDetails.lastUpdatedTimestamp" To sStatusDetailsLastUpdatedTimestamp
    Get ComStringOf Of hoJResp "creationTimestamp" To sCreationTimestamp
    Get ComStringOf Of hoJResp "expirationTimestamp" To sExpirationTimestamp
    Get ComStringOf Of hoJResp "releaseEnvironment" To sReleaseEnvironment


End_Procedure