(Visual FoxPro) PayPal - Find Completed Sales

List payments and find completed payments (sales transactions). Get the sales id, state, and total amount for each.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loJsonToken
LOCAL loSbAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lnSuccess
LOCAL loSbJsonResponse
LOCAL loJson
LOCAL loSbTemp
LOCAL lnNumPayments
LOCAL i
LOCAL j
LOCAL lnNumTransactions
LOCAL lnNumRelatedResources
LOCAL k
LOCAL loJsonSale

* 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)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

* Build the Authorization request header field value.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbAuth = CreateObject('Chilkat.StringBuilder')
* token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.Rest')
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("api.sandbox.paypal.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    CANCEL
ENDIF

* ----------------------------------------------------------------------------------------------
* 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.
loRest.ClearAllHeaders()
loRest.ClearAllQueryParams()

loRest.AddHeader("Authorization",loSbAuth.GetAsString())

* To find sales transactions, we list payments and look for those
* containing "sale" transactions
loRest.AddQueryParam("count","100")
loRest.AddQueryParam("start_index","0")
loRest.AddQueryParam("sort_by","update_time")
loRest.AddQueryParam("sort_order","asc")

* Send the GET request and get the JSON response.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbJsonResponse = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("GET","/v1/payments/payment",loSbJsonResponse)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loSbJsonResponse
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
loJson.LoadSb(loSbJsonResponse)

* (optional) Save the entire JSON response to a file to examine if desired..
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbTemp = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbTemp)
loSbTemp.WriteFile("qa_output/paypal_payments.json","utf-8",0)

? "Response Status Code = " + STR(loRest.ResponseStatusCode)

* Did we get a 200 success response?
IF (loRest.ResponseStatusCode <> 200) THEN
    ? loJson.Emit()
    ? "Failed."
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loSbJsonResponse
    RELEASE loJson
    RELEASE loSbTemp
    CANCEL
ENDIF

* We are looking for sales transactions .
* As shown below, we are looking in the "transactions" for "related_resources"
* containing "sale" JSON objects. 

* 	{ 
* 	  "payments": [
* 	    { 
* 	      "id": "PAY-66A12106PU3254228LA3BYKI",
* 	      "create_time": "2016-11-23T22:46:01Z",
* 	      "update_time": "2016-11-23T22:46:07Z",
* 	      "state": "approved",
* 	      "intent": "sale",
* 	      "payer": { 
* 	          ...
* 	          }
* 	        ]
* 	      },
* 	      "transactions": [
* 	        { 
* 	          ...
* 	          "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",

* Iterate over the payments and show each sale transaction.
lnNumPayments = loJson.SizeOfArray("payments")
i = 0
DO WHILE i < lnNumPayments

    loJson.I = i
    j = 0
    lnNumTransactions = loJson.SizeOfArray("payments[i].transactions")
    DO WHILE j < lnNumTransactions
        loJson.J = j
        lnNumRelatedResources = loJson.SizeOfArray("payments[i].transactions[j].related_resources")
        k = 0
        DO WHILE k < lnNumRelatedResources
            loJson.K = k
            IF (loJson.HasMember("payments[i].transactions[j].related_resources[k].sale") = 1) THEN
                loJsonSale = loJson.ObjectOf("payments[i].transactions[j].related_resources[k].sale")
                ? "sale id: " + loJsonSale.StringOf("id")
                ? "state: " + loJsonSale.StringOf("state")
                ? "total: " + loJsonSale.StringOf("amount.total")
                ? "----"
                RELEASE loJsonSale
            ENDIF

            k = k + 1
        ENDDO
        j = j + 1
    ENDDO
    i = i + 1
ENDDO

? "success"

RELEASE loJsonToken
RELEASE loSbAuth
RELEASE loRest
RELEASE loSbJsonResponse
RELEASE loJson
RELEASE loSbTemp