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 - List Payments

Lists payments that were created by the create payment call and are in any state. The list shows the payments that are made to the merchant who makes the call.

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
Token    Handle hoJsonToken
    Handle hoSbAuth
    Handle hoRest
    Boolean iBAutoReconnect
    Boolean iSuccess
    Variant vSbJsonResponse
    Handle hoSbJsonResponse
    Handle hoJson
    Integer iNumPayments
    Integer i
    Integer j
    Integer iNumTransactions
    String sTemp1
    Integer iTemp1

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

    // Add query parameters.
    Get ComAddQueryParam Of hoRest "count" "3" To iSuccess
    Get ComAddQueryParam Of hoRest "start_index" "0" To iSuccess
    Get ComAddQueryParam Of hoRest "sort_by" "create_time" To iSuccess
    Get ComAddQueryParam Of hoRest "sort_order" "desc" 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

    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

    // Sample JSON response is shown below.
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1
    Showln "----------------------"

    // Iterate over the payments and show some information from each..
    Get ComSizeOfArray Of hoJson "payments" To iNumPayments
    Move 0 To i
    While (i < iNumPayments)

        Set ComI Of hoJson To i
        Get ComStringOf Of hoJson "payments[i].id" To sTemp1
        Showln "id: " sTemp1
        Get ComStringOf Of hoJson "payments[i].state" To sTemp1
        Showln "state: " sTemp1
        Get ComStringOf Of hoJson "payments[i].intent" To sTemp1
        Showln "intent: " sTemp1

        Move 0 To j
        Get ComSizeOfArray Of hoJson "payments[i].transactions" To iNumTransactions
        While (j < iNumTransactions)
            Set ComJ Of hoJson To j
            Get ComStringOf Of hoJson "payments[i].transactions[j].amount.total" To sTemp1
            Showln "amount: " sTemp1
            Get ComStringOf Of hoJson "payments[i].transactions[j].description" To sTemp1
            Showln "description: " sTemp1
            Move j + 1 To j
        Loop

        Showln "----"

        Move i + 1 To i
    Loop

    Showln "success"

    // ------------------------------------------------
    // A sample JSON response:

    // 	{ 
    // 	  "payments": [
    // 	    { 
    // 	      "id": "PAY-66A12106PU3254228LA3BYKI",
    // 	      "create_time": "2016-11-23T22:46:01Z",
    // 	      "update_time": "2016-11-23T22:46:07Z",
    // 	      "state": "approved",
    // 	      "intent": "sale",
    // 	      "payer": { 
    // 	        "payment_method": "credit_card",
    // 	        "funding_instruments": [
    // 	          { 
    // 	            "credit_card": { 
    // 	              "type": "visa",
    // 	              "number": "xxxxxxxxxxxx9974",
    // 	              "expire_month": "9",
    // 	              "expire_year": "2021",
    // 	              "first_name": "Joe",
    // 	              "last_name": "Buyer"
    // 	            }
    // 	          }
    // 	        ]
    // 	      },
    // 	      "transactions": [
    // 	        { 
    // 	          "amount": { 
    // 	            "total": "7.47",
    // 	            "currency": "USD",
    // 	            "details": { 
    // 	              "subtotal": "7.47"
    // 	            }
    // 	          },
    // 	          "description": "This is the payment transaction description.",
    // 	          "related_resources": [
    // 	            { 
    // 	              "sale": { 
    // 	                "id": "70L88278E6781074B",
    // 	                "create_time": "2016-11-23T22:46:01Z",
    // 	                "update_time": "2016-11-23T22:46:07Z",
    // 	                "amount": { 
    // 	                  "total": "7.47",
    // 	                  "currency": "USD"
    // 	                },
    // 	                "state": "completed",
    // 	                "parent_payment": "PAY-66A12106PU3254228LA3BYKI",
    // 	                "links": [
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B",
    // 	                    "rel": "self",
    // 	                    "method": "GET"
    // 	                  },
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B/refund",
    // 	                    "rel": "refund",
    // 	                    "method": "POST"
    // 	                  },
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
    // 	                    "rel": "parent_payment",
    // 	                    "method": "GET"
    // 	                  }
    // 	                ]
    // 	              }
    // 	            }
    // 	          ]
    // 	        }
    // 	      ],
    // 	      "links": [
    // 	        { 
    // 	          "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
    // 	          "rel": "self",
    // 	          "method": "GET"
    // 	        }
    // 	      ]
    // 	    },
    // 	    { 
    // 	      "id": "PAY-65M1278399433341ALA3B4JY",
    // 	      "create_time": "2016-11-23T22:54:31Z",
    // 	      "update_time": "2016-11-23T22:54:35Z",
    // 	      "state": "approved",
    // 	      "intent": "sale",
    // 	      "payer": { 
    // 	        "payment_method": "credit_card",
    // 	        "funding_instruments": [
    // 	          { 
    // 	            "credit_card": { 
    // 	              "type": "visa",
    // 	              "number": "xxxxxxxxxxxx9974",
    // 	              "expire_month": "9",
    // 	              "expire_year": "2021",
    // 	              "first_name": "Joe",
    // 	              "last_name": "Buyer"
    // 	            }
    // 	          }
    // 	        ]
    // 	      },
    // 	      "transactions": [
    // 	        { 
    // 	          "amount": { 
    // 	            "total": "7.47",
    // 	            "currency": "USD",
    // 	            "details": { 
    // 	              "subtotal": "7.47"
    // 	            }
    // 	          },
    // 	          "description": "This is the payment transaction description.",
    // 	          "related_resources": [
    // 	            { 
    // 	              "sale": { 
    // 	                "id": "1CP21441CY030683B",
    // 	                "create_time": "2016-11-23T22:54:31Z",
    // 	                "update_time": "2016-11-23T22:54:35Z",
    // 	                "amount": { 
    // 	                  "total": "7.47",
    // 	                  "currency": "USD"
    // 	                },
    // 	                "state": "completed",
    // 	                "parent_payment": "PAY-65M1278399433341ALA3B4JY",
    // 	                "links": [
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B",
    // 	                    "rel": "self",
    // 	                    "method": "GET"
    // 	                  },
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B/refund",
    // 	                    "rel": "refund",
    // 	                    "method": "POST"
    // 	                  },
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
    // 	                    "rel": "parent_payment",
    // 	                    "method": "GET"
    // 	                  }
    // 	                ]
    // 	              }
    // 	            }
    // 	          ]
    // 	        }
    // 	      ],
    // 	      "links": [
    // 	        { 
    // 	          "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
    // 	          "rel": "self",
    // 	          "method": "GET"
    // 	        }
    // 	      ]
    // 	    },
    // 	    { 
    // 	      "id": "PAY-12T35751GS725073SLA3CQNQ",
    // 	      "create_time": "2016-11-23T23:37:26Z",
    // 	      "update_time": "2016-11-23T23:37:31Z",
    // 	      "state": "approved",
    // 	      "intent": "sale",
    // 	      "payer": { 
    // 	        "payment_method": "credit_card",
    // 	        "funding_instruments": [
    // 	          { 
    // 	            "credit_card_token": { 
    // 	              "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
    // 	              "payer_id": "user12345",
    // 	              "last4": "9974",
    // 	              "type": "visa",
    // 	              "expire_month": "9",
    // 	              "expire_year": "2021"
    // 	            }
    // 	          }
    // 	        ]
    // 	      },
    // 	      "transactions": [
    // 	        { 
    // 	          "amount": { 
    // 	            "total": "6.70",
    // 	            "currency": "USD",
    // 	            "details": { 
    // 	              "subtotal": "6.70"
    // 	            }
    // 	          },
    // 	          "description": "This is the payment transaction description.",
    // 	          "related_resources": [
    // 	            { 
    // 	              "sale": { 
    // 	                "id": "4F194018A1618453G",
    // 	                "create_time": "2016-11-23T23:37:26Z",
    // 	                "update_time": "2016-11-23T23:37:31Z",
    // 	                "amount": { 
    // 	                  "total": "6.70",
    // 	                  "currency": "USD"
    // 	                },
    // 	                "state": "completed",
    // 	                "parent_payment": "PAY-12T35751GS725073SLA3CQNQ",
    // 	                "links": [
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G",
    // 	                    "rel": "self",
    // 	                    "method": "GET"
    // 	                  },
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G/refund",
    // 	                    "rel": "refund",
    // 	                    "method": "POST"
    // 	                  },
    // 	                  { 
    // 	                    "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
    // 	                    "rel": "parent_payment",
    // 	                    "method": "GET"
    // 	                  }
    // 	                ]
    // 	              }
    // 	            }
    // 	          ]
    // 	        }
    // 	      ],
    // 	      "links": [
    // 	        { 
    // 	          "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
    // 	          "rel": "self",
    // 	          "method": "GET"
    // 	        }
    // 	      ]
    // 	    }
    // 	  ],
    // 	  "count": 3,
    // 	  "next_id": "PAY-2005552565085590VLA3CR5Q"
    // 	}


End_Procedure

 

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