Swift
Swift
PayPal - Show Invoice Details
See more PayPal Examples
Shows details for a PayPal invoice, by ID.See also PayPal Show Invoice Details REST API Reference
Chilkat Swift Downloads
func chilkatTest() {
var success: Bool = false
// Note: Requires Chilkat v9.5.0.64 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(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 != 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..
// ----------------------------------------------------------------------------------------------
rest.addHeader(name: "Authorization", value: sbAuth.getAsString())
var invoiceId: String? = "INV2-XV4B-736P-PLVN-SZCE"
let sbPath = CkoStringBuilder()!
sbPath.append(value: "/v1/invoicing/invoices/")
sbPath.append(value: invoiceId)
// Send the GET request and get the JSON response.
let sbJsonResponse = CkoStringBuilder()!
success = rest.fullRequestNoBodySb(httpVerb: "GET", uriPath: sbPath.getAsString(), sb: sbJsonResponse)
if success != true {
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 response JSON is shown below.
// Get some information..
print("email: \(json.string(of: "merchant_info.email")!)")
print("business_name: \(json.string(of: "merchant_info.business_name")!)")
var numItems: Int = json.size(ofArray: "items").intValue
var i: Int = 0
while i < numItems {
json.i = i
print("item name: \(json.string(of: "items[i].name")!)")
print("item quantity: \(json.string(of: "items[i].quantity")!)")
print("item currency: \(json.string(of: "items[i].unit_price.currency")!)")
print("item value: \(json.string(of: "items[i].unit_price.value")!)")
print("----")
i = i + 1
}
print("Success.")
// ---------------------------------------------------
// A sample response:
// {
// "id": "INV2-XV4B-736P-PLVN-SZCE",
// "number": "0002",
// "template_id": "TEMP-8HS37702UW384535K",
// "status": "DRAFT",
// "merchant_info": {
// "email": "smith-facilitator@chilkatsoft.com",
// "first_name": "Joe",
// "last_name": "Facilitator",
// "business_name": "Medical Professionals, LLC",
// "phone": {
// "country_code": "001",
// "national_number": "5032141716"
// },
// "address": {
// "line1": "1234 Main St.",
// "city": "Portland",
// "state": "OR",
// "postal_code": "97217",
// "country_code": "US"
// }
// },
// "billing_info": [
// {
// "email": "smith-buyer@chilkatsoft.com"
// }
// ],
// "shipping_info": {
// "first_name": "Sally",
// "last_name": "Patient",
// "business_name": "Not applicable",
// "phone": {
// "country_code": "001",
// "national_number": "5039871234"
// },
// "address": {
// "line1": "1234 Broad St.",
// "city": "Portland",
// "state": "OR",
// "postal_code": "97216",
// "country_code": "US"
// }
// },
// "items": [
// {
// "name": "Sutures",
// "quantity": 100.0,
// "unit_price": {
// "currency": "USD",
// "value": "5.00"
// }
// }
// ],
// "invoice_date": "2016-11-15 PST",
// "payment_term": {
// "term_type": "NET_45",
// "due_date": "2016-12-30 PST"
// },
// "tax_calculated_after_discount": false,
// "tax_inclusive": false,
// "note": "Medical Invoice 16 Jul, 2013 PST",
// "total_amount": {
// "currency": "USD",
// "value": "500.00"
// },
// "metadata": {
// "created_date": "2016-11-15 08:09:21 PST"
// },
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// "method": "GET"
// },
// {
// "rel": "send",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
// "method": "POST"
// },
// {
// "rel": "update",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
// "method": "PUT"
// },
// {
// "rel": "delete",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// "method": "DELETE"
// }
// ]
// }
//
}