Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

DataFlex Web API Examples

Primary Categories

AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Jira
MYOB

Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
Xero
eBay
effectconnect

 

 

 

(DataFlex) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoJsonToken
    Handle hoSbAuth
    Handle hoRest
    Boolean iBAutoReconnect
    Boolean iSuccess
    Variant vSbJsonResponse
    Handle hoSbJsonResponse
    Handle hoJson
    Variant vSbTemp
    Handle hoSbTemp
    Integer iNumPayments
    Integer i
    Integer j
    Integer iNumTransactions
    Integer iNumRelatedResources
    Integer k
    Variant vJsonCapture
    Handle hoJsonCapture
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    // Note: Requires Chilkat v9.5.0.65 or greater.

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

    // Load our previously obtained access token. (see PayPal OAuth2 Access Token)
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/paypal.json" To iSuccess

    // Build the Authorization request header field value.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
    If (Not(IsComObjectCreated(hoSbAuth))) Begin
        Send CreateComObject of hoSbAuth
    End
    // token_type should be "Bearer"
    Get ComStringOf Of hoJsonToken "token_type" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess
    Get ComAppend Of hoSbAuth " " To iSuccess
    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess

    // Make the initial connection.
    // A single REST object, once connected, can be used for many PayPal REST API calls.
    // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    // then it will be automatically re-established as needed.
    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "api.sandbox.paypal.com" 443 True iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // ----------------------------------------------------------------------------------------------
    // The code above this comment could be placed inside a function/subroutine within the application
    // because the connection does not need to be made for every request.  Once the connection is made
    // the app may send many requests..
    // ----------------------------------------------------------------------------------------------

    // Clear the REST object of any headers or query params from previous requests.
    Get ComClearAllHeaders Of hoRest To iSuccess
    Get ComClearAllQueryParams Of hoRest To iSuccess

    Get ComGetAsString Of hoSbAuth To sTemp1
    Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess

    // To find captured payments, we list payments and look for those
    // containing a "capture" resource.
    Get ComAddQueryParam Of hoRest "count" "100" To iSuccess
    Get ComAddQueryParam Of hoRest "start_index" "0" To iSuccess
    Get ComAddQueryParam Of hoRest "sort_by" "update_time" To iSuccess
    Get ComAddQueryParam Of hoRest "sort_order" "asc" To iSuccess

    // Send the GET request and get the JSON response.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonResponse
    If (Not(IsComObjectCreated(hoSbJsonResponse))) Begin
        Send CreateComObject of hoSbJsonResponse
    End
    Get pvComObject of hoSbJsonResponse to vSbJsonResponse
    Get ComFullRequestNoBodySb Of hoRest "GET" "/v1/payments/payment" vSbJsonResponse To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Set ComEmitCompact Of hoJson To False
    Get pvComObject of hoSbJsonResponse to vSbJsonResponse
    Get ComLoadSb Of hoJson vSbJsonResponse To iSuccess

    // (optional) Save the entire JSON response to a file to examine if desired..
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbTemp
    If (Not(IsComObjectCreated(hoSbTemp))) Begin
        Send CreateComObject of hoSbTemp
    End
    Get pvComObject of hoSbTemp to vSbTemp
    Get ComEmitSb Of hoJson vSbTemp To iSuccess
    Get ComWriteFile Of hoSbTemp "qa_output/paypal_payments.json" "utf-8" False To iSuccess

    Get ComResponseStatusCode Of hoRest To iTemp1
    Showln "Response Status Code = " iTemp1

    // Did we get a 200 success response?
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 200) Begin
        Get ComEmit Of hoJson To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    // We are looking for "capture" resources .
    // As shown below, we are looking in the "transactions" for "related_resources"
    // containing "capture" JSON objects. 

    // 	{ 
    // 	  "payments": [
    // 	    { 
    // 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
    // 	      "create_time": "2016-11-24T00:33:51Z",
    // 	      "update_time": "2016-11-24T00:40:54Z",
    // 	      "state": "approved",
    // 	      "intent": "authorize",
    // 	      "payer": { 
    // 	        "payment_method": "credit_card",
    // 	        "funding_instruments": [
    // 	          { 
    // 	            ...
    // 	          }
    // 	        ]
    // 	      },
    // 	      "transactions": [
    // 	        { 
    // 	          "amount": { 
    // 	            ...
    // 	          },
    // 	          "description": "This is the payment transaction description.",
    // 	          "related_resources": [
    // 	            { 
    // 	              "authorization": { 
    // 	                ...
    // 	              }
    // 	            },
    // 	            { 
    // 	              "capture": { 
    // 	                "id": "1LY5310469661362J",
    // 	                "create_time": "2016-11-24T00:40:50Z",
    // 	                "update_time": "2016-11-24T00:40:54Z",
    // 	                "amount": { 
    // 	                  "total": "4.54",
    // 	                  "currency": "USD"
    // 	                },
    // 	                "state": "completed",
    // 	                "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    // 	                "transaction_fee": { 
    // 	                  "value": "0.43",
    // 	                  "currency": "USD"
    // 	                },
    // 			...
    // 

    // Iterate over the payments and show each capture
    Get ComSizeOfArray Of hoJson "payments" To iNumPayments
    Move 0 To i
    While (i < iNumPayments)
        Set ComI Of hoJson To i
        Move 0 To j
        Get ComSizeOfArray Of hoJson "payments[i].transactions" To iNumTransactions
        While (j < iNumTransactions)
            Set ComJ Of hoJson To j
            Get ComSizeOfArray Of hoJson "payments[i].transactions[j].related_resources" To iNumRelatedResources
            Move 0 To k
            While (k < iNumRelatedResources)
                Set ComK Of hoJson To k
                Get ComHasMember Of hoJson "payments[i].transactions[j].related_resources[k].capture" To bTemp1
                If (bTemp1 = True) Begin
                    Get ComObjectOf Of hoJson "payments[i].transactions[j].related_resources[k].capture" To vJsonCapture
                    If (IsComObject(vJsonCapture)) Begin
                        Get Create (RefClass(cComChilkatJsonObject)) To hoJsonCapture
                        Set pvComObject Of hoJsonCapture To vJsonCapture
                    End
                    Get ComStringOf Of hoJsonCapture "id" To sTemp1
                    Showln "capture id: " sTemp1
                    Get ComStringOf Of hoJsonCapture "state" To sTemp1
                    Showln "state: " sTemp1
                    Get ComStringOf Of hoJsonCapture "amount.total" To sTemp1
                    Showln "total: " sTemp1
                    Showln "----"
                    Send Destroy of hoJsonCapture
                End

                Move k + 1 To k
            Loop

            Move j + 1 To j
        Loop

        Move i + 1 To i
    Loop

    Showln "success"


End_Procedure

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.