Swift

PayPal - Create a PayPal Payment

See more PayPal Examples

Creates a payment to be paid from a PayPal account (as opposed to being funded by a credit card).

Note: This example requires Chilkat v9.5.0.65 or greater.

Swift

func chilkatTest() {
    var success: Bool = false

    // 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(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..
    // ----------------------------------------------------------------------------------------------

    // Build the JSON containing the transaction information.
    let json = CkoJsonObject()!
    json.emitCompact = false
    json.updateString(jsonPath: "intent", value: "sale")
    json.updateString(jsonPath: "redirect_urls.return_url", value: "http://www.example.com/return_url")
    json.updateString(jsonPath: "redirect_urls.cancel_url", value: "http://www.example.com/cancel_url")
    json.updateString(jsonPath: "payer.payment_method", value: "paypal")
    json.updateString(jsonPath: "transactions[0].amount.total", value: "7.47")
    json.updateString(jsonPath: "transactions[0].amount.currency", value: "USD")
    json.updateString(jsonPath: "transactions[0].description", value: "This is the payment transaction description.")

    print("\(json.emit()!)")

    // The JSON created by the above code is this:

    // 	{ 
    // 	  "intent": "sale",
    // 	  "redirect_urls": { 
    // 	    "return_url": "http://www.example.com/return_url",
    // 	    "cancel_url": "http://www.example.com/cancel_url"
    // 	  },
    // 	  "payer": { 
    // 	    "payment_method": "paypal"
    // 	  },
    // 	  "transactions": [
    // 	    { 
    // 	      "amount": { 
    // 	        "total": "7.47",
    // 	        "currency": "USD"
    // 	      },
    // 	      "description": "This is the payment transaction description."
    // 	    }
    // 	  ]
    // 	}

    rest.addHeader(name: "Authorization", value: sbAuth.getAsString())
    rest.addHeader(name: "Content-Type", value: "application/json")

    // Send the POST request containign the JSON in the request body, and get the JSON response.
    let sbJsonRequest = CkoStringBuilder()!
    json.emitCompact = true
    json.emitSb(sb: sbJsonRequest)
    let sbJsonResponse = CkoStringBuilder()!
    success = rest.fullRequestSb(httpVerb: "POST", uriPath: "/v1/payments/payment", requestBody: sbJsonRequest, responseBody: sbJsonResponse)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    json.emitCompact = false
    json.loadSb(sb: sbJsonResponse)

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

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

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

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

    // 	{ 
    // 	  "id": "PAY-1XK50350XV338620BLA3CZGI",
    // 	  "intent": "sale",
    // 	  "state": "created",
    // 	  "payer": { 
    // 	    "payment_method": "paypal",
    // 	    "use_vendor_currency_conversion": false
    // 	  },
    // 	  "transactions": [
    // 	    { 
    // 	      "amount": { 
    // 	        "total": "7.47",
    // 	        "currency": "USD"
    // 	      },
    // 	      "description": "This is the payment transaction description.",
    // 	      "related_resources": [
    // 	      ]
    // 	    }
    // 	  ],
    // 	  "create_time": "2016-11-23T23:56:09Z",
    // 	  "links": [
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI",
    // 	      "rel": "self",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0BG932459F977083J",
    // 	      "rel": "approval_url",
    // 	      "method": "REDIRECT"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI/execute",
    // 	      "rel": "execute",
    // 	      "method": "POST"
    // 	    }
    // 	  ]
    // 	}

}