PureBasic

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. PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkPrivateKey.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    privKey.i = CkPrivateKey::ckCreate()
    If privKey.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkPrivateKey::ckLoadPemFile(privKey,"C:/someDir/myAmazonPayPrivateKey.pem")
    If success = 0
        Debug CkPrivateKey::ckLastErrorText(privKey)
        CkHttp::ckDispose(http)
        CkPrivateKey::ckDispose(privKey)
        ProcedureReturn
    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
    publicKeyId.s = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
    success = CkHttp::ckSetAuthPrivateKey(http,publicKeyId,privKey)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkPrivateKey::ckDispose(privKey)
        ProcedureReturn
    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

    CkHttp::setCkAccept(http, "application/json")

    respStatusCode.i = 0

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckSetUrlVar(http,"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
    success = CkHttp::ckQuickGetSb(http,"https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}",sbResponseBody)
    If success = 0
        ; If the LastStatus is not equal to 0, then we received a response, but it was an error response.
        respStatusCode = CkHttp::ckLastStatus(http)
        If respStatusCode <> 0
            Debug "Response Status Code = " + Str(respStatusCode)
            Debug "Response body:"
            Debug CkHttp::ckLastResponseBody(http)
        Else
            Debug CkHttp::ckLastErrorText(http)
        EndIf

        CkHttp::ckDispose(http)
        CkPrivateKey::ckDispose(privKey)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    ; We expect a 200 status code for success.
    ; Note: Some Amazon Pay API calls return 200 for success, others return 201.
    If respStatusCode <> 200
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkPrivateKey::ckDispose(privKey)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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

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


    CkHttp::ckDispose(http)
    CkPrivateKey::ckDispose(privKey)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure