(Swift 3,4,5...) PayPal - Refund Sale

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

    // To refund a particular amount, build JSON such as this:
    let jsonPartial = CkoJsonObject()!
    jsonPartial.emitCompact = false
    jsonPartial.update("amount.total", value: "2.34")
    jsonPartial.update("amount.currency", value: "USD")
    // invoice_number is optional..
    jsonPartial.update("invoice_number", value: "INV-1234567")
    print("\(jsonPartial.emit()!)")

    // The JSON for a partial refund:

    // 	{ 
    // 	  "amount": { 
    // 	    "total": "2.34",
    // 	    "currency": "USD"
    // 	  },
    // 	  "invoice_number": "INV-1234567"
    // 	}

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

    // 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("/v1/payments/sale/sale_id/refund")
    var numReplaced: Int = sbPath.replace("sale_id", replacement: "1XC17935MN507400J").intValue

    // Send the POST request containign the JSON in the request body, and get the JSON response.
    let sbJsonRequest = CkoStringBuilder()!
    jsonPartial.emitCompact = true
    jsonPartial.emitSb(sbJsonRequest)
    let sbJsonResponse = CkoStringBuilder()!

    var bFullRefund: Bool = true
    // To send a full refund, send an empty request body:
    if bFullRefund == true {
        sbJsonRequest.clear()
        sbJsonRequest.append("{}")
    }

    success = rest.fullRequestSb("POST", uriPath: sbPath.getAsString(), requestBody: sbJsonRequest, responseBody: sbJsonResponse)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    let json = CkoJsonObject()!
    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
    }

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

    // A successful JSON response:
    // The "id" is the refund_id.

    // 	{ 
    // 	  "id": "7NE550583A133505U",
    // 	  "create_time": "2016-11-26T16:38:27Z",
    // 	  "update_time": "2016-11-26T16:38:27Z",
    // 	  "state": "completed",
    // 	  "amount": { 
    // 	    "total": "289.00",
    // 	    "currency": "USD"
    // 	  },
    // 	  "sale_id": "1XC17935MN507400J",
    // 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
    // 	  "links": [
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
    // 	      "rel": "self",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
    // 	      "rel": "parent_payment",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
    // 	      "rel": "sale",
    // 	      "method": "GET"
    // 	    }
    // 	  ]
    // 	}

}