Swift

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded.

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 request body containing the reminder information:
    let json = CkoJsonObject()!
    json.emitCompact = false
    let dtNow = CkoDateTime()!
    dtNow.setFromCurrentSystemTime()
    let sbDt = CkoStringBuilder()!
    sbDt.append(value: dtNow.get(asTimestamp: false))
    var numReplaced: Int = sbDt.replace(value: "T", replacement: " ").intValue
    numReplaced = sbDt.replace(value: "Z", replacement: " UTC").intValue
    json.updateString(jsonPath: "date", value: sbDt.getAsString())
    json.updateString(jsonPath: "note", value: "Refunded by credit card!")
    json.updateString(jsonPath: "amount.currency", value: "USD")
    json.updateString(jsonPath: "amount.value", value: "500.00")
    print("\(json.emit()!)")

    // The JSON created by the above code:

    // 	{ 
    // 	  "date": "2016-11-28 21:05:38 UTC",
    // 	  "note": "Refunded by credit card!",
    // 	  "amount": { 
    // 	    "currency": "USD",
    // 	    "value": "500.00"
    // 	  }
    // 	}

    // Build a path using a previously-sent invoice ID.
    let sbPath = CkoStringBuilder()!
    sbPath.append(value: "/v1/invoicing/invoices/invoice_id/record-refund")
    var numReplacements: Int = sbPath.replace(value: "invoice_id", replacement: "INV2-QCHR-QHSD-M2VU-AVXC").intValue

    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: sbPath.getAsString(), requestBody: sbRequestBody, responseBody: sbResponseBody)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

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

    // Check for a success response.
    if rest.responseStatusCode.intValue != 204 {
        print("\(sbResponseBody.getAsString()!)")
        print("Failed.")
        return
    }

    // For a success response, the response body is empty.
    print("Success.")

}