Swift
Swift
PayPal Create Invoice
See more PayPal Examples
Creates a draft invoice.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..
// ----------------------------------------------------------------------------------------------
// First create a JSON invoice:
let json = CkoJsonObject()!
json.emitCompact = false
json.updateString(jsonPath: "merchant_info.email", value: "frank-facilitator@example.com")
json.updateString(jsonPath: "merchant_info.first_name", value: "Frank")
json.updateString(jsonPath: "merchant_info.last_name", value: "Facilitator")
json.updateString(jsonPath: "merchant_info.business_name", value: "Medical Professionals, LLC")
json.updateString(jsonPath: "merchant_info.phone.country_code", value: "001")
json.updateString(jsonPath: "merchant_info.phone.national_number", value: "5032141716")
json.updateString(jsonPath: "merchant_info.address.line1", value: "1234 Main St.")
json.updateString(jsonPath: "merchant_info.address.city", value: "Portland")
json.updateString(jsonPath: "merchant_info.address.state", value: "OR")
json.updateString(jsonPath: "merchant_info.address.postal_code", value: "97217")
json.updateString(jsonPath: "merchant_info.address.country_code", value: "US")
json.updateString(jsonPath: "billing_info[0].email", value: "frank-buyer@somewhere.com")
json.updateString(jsonPath: "items[0].name", value: "Sutures")
json.updateInt(jsonPath: "items[0].quantity", value: 100)
json.updateString(jsonPath: "items[0].unit_price.currency", value: "USD")
json.updateString(jsonPath: "items[0].unit_price.value", value: "5")
json.updateString(jsonPath: "note", value: "Medical Invoice 16 Jul, 2013 PST")
json.updateString(jsonPath: "payment_term.term_type", value: "NET_45")
json.updateString(jsonPath: "shipping_info.first_name", value: "Sally")
json.updateString(jsonPath: "shipping_info.last_name", value: "Patient")
json.updateString(jsonPath: "shipping_info.business_name", value: "Not applicable")
json.updateString(jsonPath: "shipping_info.phone.country_code", value: "001")
json.updateString(jsonPath: "shipping_info.phone.national_number", value: "5039871234")
json.updateString(jsonPath: "shipping_info.address.line1", value: "1234 Broad St.")
json.updateString(jsonPath: "shipping_info.address.city", value: "Portland")
json.updateString(jsonPath: "shipping_info.address.state", value: "OR")
json.updateString(jsonPath: "shipping_info.address.postal_code", value: "97216")
json.updateString(jsonPath: "shipping_info.address.country_code", value: "US")
print("\(json.emit()!)")
// The JSON invoice created by the above code:
// {
// "merchant_info": {
// "email": "frank-facilitator@example.com",
// "first_name": "Frank",
// "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": "frank-buyer@somewhere.com"
// }
// ],
// "items": [
// {
// "name": "Sutures",
// "quantity": 100,
// "unit_price": {
// "currency": "USD",
// "value": "5"
// }
// }
// ],
// "note": "Medical Invoice 16 Jul, 2013 PST",
// "payment_term": {
// "term_type": "NET_45"
// },
// "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"
// }
// }
// }
// Send the POST equivalent to this CURL command:
// curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/invoices/ \
// -H "Content-Type:application/json" \
// -H "Authorization: Bearer Access-Token" \
// -d '{ invoice JSON goes here }'
json.emitCompact = true
let sbRequestBody = CkoStringBuilder()!
let sbResponseBody = CkoStringBuilder()!
rest.addHeader(name: "Content-Type", value: "application/json")
rest.addHeader(name: "Authorization", value: sbAuth.getAsString())
json.emitSb(sb: sbRequestBody)
success = rest.fullRequestSb(httpVerb: "POST", uriPath: "/v1/invoicing/invoices", requestBody: sbRequestBody, responseBody: sbResponseBody)
if success != true {
print("\(rest.lastErrorText!)")
return
}
// We should have some sort of JSON response. It could be successful, or an error.
let jsonResponse = CkoJsonObject()!
jsonResponse.emitCompact = false
jsonResponse.loadSb(sb: sbResponseBody)
print("Response Status Code = \(rest.responseStatusCode.intValue)")
// Did we get a 201 success response?
if rest.responseStatusCode.intValue != 201 {
// Show the JSON response body
print("\(jsonResponse.emit()!)")
print("\(rest.lastRequestStartLine!)")
print("\(rest.lastRequestHeader!)")
print("Failed.")
return
}
// Show a few parts of the JSON response
print("id: \(jsonResponse.string(of: "id")!)")
print("number: \(jsonResponse.string(of: "number")!)")
print("template_id: \(jsonResponse.string(of: "template_id")!)")
print("status: \(jsonResponse.string(of: "status")!)")
// Show the full JSON response.
print("\(jsonResponse.emit()!)")
print("Success.")
// A successful response looks like this:
// {
// "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
// "number": "0001",
// "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 06:17:03 PST"
// },
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// "method": "GET"
// },
// {
// "rel": "send",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/send",
// "method": "POST"
// },
// {
// "rel": "update",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
// "method": "PUT"
// },
// {
// "rel": "delete",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// "method": "DELETE"
// }
// ]
// }
//
}