Swift Requires Chilkat v11.0.0+

PayPal - Get Sale Details

See more PayPal Examples

Shows details for a sale transaction, by ID. Swift

func chilkatTest() {
    var success: Bool = false

    //  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(path: "qa_data/tokens/paypal.json")

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

    //  The sale ID is added to the path.
    //  The sale ID is obtained from payment records as shown here: Find Completed Sales
    let sbPath = CkoStringBuilder()!
    sbPath.append(value: "/v1/payments/sale/sale_id")
    var numReplaced: Int = sbPath.replace(value: "sale_id", replacement: "1XC17935MN507400J").intValue

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

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

    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
    }

    //  Sample JSON response is shown below.
    print("\(json.emit()!)")
    print("----------------------")

    //  Show how to get a timestamp, such as update_time.
    let dateTime = CkoDateTime()!
    success = dateTime.set(fromTimestamp: json.string(of: "update_time"))
    print("utc update_time: \(dateTime.get(asTimestamp: false)!)")
    print("local update_time: \(dateTime.get(asTimestamp: true)!)")
    print("utc rfc822: \(dateTime.get(asRfc822: false)!)")
    print("local rfc822: \(dateTime.get(asRfc822: true)!)")

    let dtUtc = CkoDtObj()!
    dateTime.toDtObj(bLocal: false, dtObj: dtUtc)

    print("\(dtUtc.month.intValue)/\(dtUtc.day.intValue)/\(dtUtc.year.intValue)")

    print("success")

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

    //  	{ 
    //  	  "id": "1XC17935MN507400J",
    //  	  "create_time": "2016-11-25T15:42:50Z",
    //  	  "update_time": "2016-11-25T15:42:56Z",
    //  	  "amount": { 
    //  	    "total": "289.00",
    //  	    "currency": "USD"
    //  	  },
    //  	  "payment_mode": "INSTANT_TRANSFER",
    //  	  "state": "completed",
    //  	  "protection_eligibility": "ELIGIBLE",
    //  	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
    //  	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
    //  	  "transaction_fee": { 
    //  	    "value": "8.68",
    //  	    "currency": "USD"
    //  	  },
    //  	  "links": [
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
    //  	      "rel": "self",
    //  	      "method": "GET"
    //  	    },
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
    //  	      "rel": "refund",
    //  	      "method": "POST"
    //  	    },
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
    //  	      "rel": "parent_payment",
    //  	      "method": "GET"
    //  	    }
    //  	  ]
    //  	}

}