(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

// 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)
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loSbAuth = createobject("CkStringBuilder")
// 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.
loRest = createobject("CkRest")
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.sandbox.paypal.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    return
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.
loSbJsonResponse = createobject("CkStringBuilder")
llSuccess = loRest.FullRequestNoBodySb("GET","/v1/payments/payment",loSbJsonResponse)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    release loSbJsonResponse
    return
endif

loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.
loJson.LoadSb(loSbJsonResponse)

// (optional) Save the entire JSON response to a file to examine if desired..
loSbTemp = createobject("CkStringBuilder")
loJson.EmitSb(loSbTemp)
loSbTemp.WriteFile("qa_output/paypal_payments.json","utf-8",.F.)

? "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
    return
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") = .T.) 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