Xbase++ Requires Chilkat v11.0.0+

PayPal - Find Completed Sales

See more PayPal Examples

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

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oSbAuth
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oSbJsonResponse
LOCAL oJson
LOCAL oSbTemp
LOCAL oJsonSale
LOCAL nNumPayments
LOCAL i
LOCAL j
LOCAL nNumTransactions
LOCAL nNumRelatedResources
LOCAL k

nSuccess := 0

//  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)
oJsonToken := CreateObject("Chilkat.JsonObject")
oJsonToken:LoadFile("qa_data/tokens/paypal.json")

//  Build the Authorization request header field value.
oSbAuth := CreateObject("Chilkat.StringBuilder")
//  token_type should be "Bearer"
oSbAuth:Append(oJsonToken:StringOf("token_type"))
oSbAuth:Append(" ")
oSbAuth:Append(oJsonToken: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.
oRest := CreateObject("Chilkat.Rest")
nBAutoReconnect := 1
nSuccess := oRest:Connect("api.sandbox.paypal.com", 443, 1, nBAutoReconnect)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    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.
oRest:ClearAllHeaders()
oRest:ClearAllQueryParams()

oRest:AddHeader("Authorization", oSbAuth:GetAsString())

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

//  Send the GET request and get the JSON response.
oSbJsonResponse := CreateObject("Chilkat.StringBuilder")
nSuccess := oRest:FullRequestNoBodySb("GET", "/v1/payments/payment", oSbJsonResponse)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oSbJsonResponse:destroy()
    RETURN
ENDIF

oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0
oJson:LoadSb(oSbJsonResponse)

//  (optional) Save the entire JSON response to a file to examine if desired..
oSbTemp := CreateObject("Chilkat.StringBuilder")
oJson:EmitSb(oSbTemp)
oSbTemp:WriteFile("qa_output/paypal_payments.json", "utf-8", 0)

? "Response Status Code = " + Str(oRest:ResponseStatusCode)

//  Did we get a 200 success response?
IF (oRest:ResponseStatusCode != 200)
    ? oJson:Emit()
    ? "Failed."
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oSbJsonResponse:destroy()
    oJson:destroy()
    oSbTemp:destroy()
    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.
oJsonSale := CreateObject("Chilkat.JsonObject")
nNumPayments := oJson:SizeOfArray("payments")
i := 0
DO WHILE i < nNumPayments

    oJson:I := i
    j := 0
    nNumTransactions := oJson:SizeOfArray("payments[i].transactions")
    DO WHILE j < nNumTransactions
        oJson:J := j
        nNumRelatedResources := oJson:SizeOfArray("payments[i].transactions[j].related_resources")
        k := 0
        DO WHILE k < nNumRelatedResources
            oJson:K := k
            IF (oJson:HasMember("payments[i].transactions[j].related_resources[k].sale") == 1)

                oJson:ObjectOf2("payments[i].transactions[j].related_resources[k].sale", oJsonSale)

                ? "sale id: " + oJsonSale:StringOf("id")
                ? "state: " + oJsonSale:StringOf("state")
                ? "total: " + oJsonSale:StringOf("amount.total")
                ? "----"
            ENDIF

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

? "success"

oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oSbJsonResponse:destroy()
oJson:destroy()
oSbTemp:destroy()
oJsonSale:destroy()