(Swift 3,4,5...) PayPal - Authorize a Payment

Creates an authorization for a payment. This is for the case where the payment will first be authorized, and then captured at a later date. (In other words, the buyer is providing his/her credit card information now, and the actual charge (capture) will take place at a later time.)

Creating the authorization is the same as creating "sale" payment, except the intent is set to "authorize" instead of "sale".

This example requests an authorization for a credit card payment (using a credit card ID previoulsy stored in the PayPal vault).

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

    // Build the JSON containing the transaction information.
    let json = CkoJsonObject()!
    json.emitCompact = false
    json.update("intent", value: "authorize")
    json.update("payer.payment_method", value: "credit_card")
    json.update("payer.funding_instruments[0].credit_card_token.credit_card_id", value: "CARD-52W84623JH8043102LA3CLGA")
    json.update("payer.funding_instruments[0].credit_card_token.payer_id", value: "user12345")
    json.update("transactions[0].amount.total", value: "6.70")
    json.update("transactions[0].amount.currency", value: "USD")
    json.update("transactions[0].description", value: "This is the payment transaction description.")

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

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

    // 	{ 
    // 	  "intent": "authorize",
    // 	  "payer": { 
    // 	    "payment_method": "credit_card",
    // 	    "funding_instruments": [
    // 	      { 
    // 	        "credit_card_token": { 
    // 	          "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
    // 	          "payer_id": "user12345"
    // 	        }
    // 	      }
    // 	    ]
    // 	  },
    // 	  "transactions": [
    // 	    { 
    // 	      "amount": { 
    // 	        "total": "6.70",
    // 	        "currency": "USD"
    // 	      },
    // 	      "description": "This is the payment transaction description."
    // 	    }
    // 	  ]
    // 	}

    rest.addHeader("Authorization", value: sbAuth.getAsString())
    rest.addHeader("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(sbJsonRequest)
    let sbJsonResponse = CkoStringBuilder()!
    success = rest.fullRequestSb("POST", uriPath: "/v1/payments/payment", requestBody: sbJsonRequest, responseBody: sbJsonResponse)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    json.emitCompact = false
    json.loadSb(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()!)")
    // The authorization ID found in the related_resources is used to capture the payment at a later time.
    print("authorization id: \(json.string(of: "transactions[0].related_resources[0].authorization.id")!)")
    print("success")

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

    // 	{ 
    // 	  "id": "PAY-2CY489250W145633HLA3DK3Y",
    // 	  "create_time": "2016-11-24T00:33:51Z",
    // 	  "update_time": "2016-11-24T00:33:58Z",
    // 	  "state": "approved",
    // 	  "intent": "authorize",
    // 	  "payer": { 
    // 	    "payment_method": "credit_card",
    // 	    "funding_instruments": [
    // 	      { 
    // 	        "credit_card_token": { 
    // 	          "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
    // 	          "payer_id": "user12345",
    // 	          "last4": "9974",
    // 	          "type": "visa",
    // 	          "expire_month": "9",
    // 	          "expire_year": "2021"
    // 	        }
    // 	      }
    // 	    ]
    // 	  },
    // 	  "transactions": [
    // 	    { 
    // 	      "amount": { 
    // 	        "total": "6.70",
    // 	        "currency": "USD",
    // 	        "details": { 
    // 	          "subtotal": "6.70"
    // 	        }
    // 	      },
    // 	      "description": "This is the payment transaction description.",
    // 	      "related_resources": [
    // 	        { 
    // 	          "authorization": { 
    // 	            "id": "7X8332687A4929542",
    // 	            "create_time": "2016-11-24T00:33:51Z",
    // 	            "update_time": "2016-11-24T00:33:58Z",
    // 	            "amount": { 
    // 	              "total": "6.70",
    // 	              "currency": "USD",
    // 	              "details": { 
    // 	                "subtotal": "6.70"
    // 	              }
    // 	            },
    // 	            "state": "authorized",
    // 	            "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    // 	            "valid_until": "2016-12-23T00:33:51Z",
    // 	            "links": [
    // 	              { 
    // 	                "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
    // 	                "rel": "self",
    // 	                "method": "GET"
    // 	              },
    // 	              { 
    // 	                "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542/capture",
    // 	                "rel": "capture",
    // 	                "method": "POST"
    // 	              },
    // 	              { 
    // 	                "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542/void",
    // 	                "rel": "void",
    // 	                "method": "POST"
    // 	              },
    // 	              { 
    // 	                "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
    // 	                "rel": "parent_payment",
    // 	                "method": "GET"
    // 	              }
    // 	            ],
    // 	            "processor_response": { 
    // 	              "avs_code": "X",
    // 	              "cvv_code": "M"
    // 	            },
    // 	            "fmf_details": {}
    // 	          }
    // 	        }
    // 	      ]
    // 	    }
    // 	  ],
    // 	  "links": [
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
    // 	      "rel": "self",
    // 	      "method": "GET"
    // 	    }
    // 	  ]
    // 	}

}