(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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)
    let jsonToken = CkoJsonObject()!
    jsonToken.loadFile("qa_data/tokens/paypal.json")

    // Build the Authorization request header field value.
    let sbAuth = CkoStringBuilder()!
    // token_type should be "Bearer"
    sbAuth.append(jsonToken.string(of: "token_type"))
    sbAuth.append(" ")
    sbAuth.append(jsonToken.string(of: "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.
    let rest = CkoRest()!
    var bAutoReconnect: Bool = true
    var success: Bool = rest.connect("api.sandbox.paypal.com", port: 443, tls: true, autoReconnect: bAutoReconnect)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // ----------------------------------------------------------------------------------------------
    // 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.
    rest.clearAllHeaders()
    rest.clearAllQueryParams()

    rest.addHeader("Authorization", value: sbAuth.getAsString())

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

    // Send the GET request and get the JSON response.
    let sbJsonResponse = CkoStringBuilder()!
    success = rest.fullRequestNoBodySb("GET", uriPath: "/v1/payments/payment", sb: sbJsonResponse)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    let json = CkoJsonObject()!
    json.emitCompact = false
    json.loadSb(sbJsonResponse)

    // (optional) Save the entire JSON response to a file to examine if desired..
    let sbTemp = CkoStringBuilder()!
    json.emitSb(sbTemp)
    sbTemp.writeFile("qa_output/paypal_payments.json", charset: "utf-8", emitBom: false)

    print("Response Status Code = \(rest.responseStatusCode.intValue)")

    // Did we get a 200 success response?
    if rest.responseStatusCode.intValue != 200 {
        print("\(json.emit()!)")
        print("Failed.")
        return
    }

    // 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.
    var numPayments: Int = json.size(ofArray: "payments").intValue
    var i: Int = 0
    while i < numPayments {

        json.i = i
        var j: Int = 0
        var numTransactions: Int = json.size(ofArray: "payments[i].transactions").intValue
        while j < numTransactions {
            json.j = j
            var numRelatedResources: Int = json.size(ofArray: "payments[i].transactions[j].related_resources").intValue
            var k: Int = 0
            while k < numRelatedResources {
                json.k = k
                if json.hasMember("payments[i].transactions[j].related_resources[k].sale") == true {
                    var jsonSale: CkoJsonObject? = json.object(of: "payments[i].transactions[j].related_resources[k].sale")
                    print("sale id: \(jsonSale!.string(of: "id")!)")
                    print("state: \(jsonSale!.string(of: "state")!)")
                    print("total: \(jsonSale!.string(of: "amount.total")!)")
                    print("----")
                    jsonSale = nil
                }

                k = k + 1
            }

            j = j + 1
        }

        i = i + 1
    }

    print("success")

}