Swift

PayPal - Delete Draft Invoice

See more PayPal Examples

Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can cancel the invoice.

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

    rest.addHeader(name: "Authorization", value: sbAuth.getAsString())

    var invoiceId: String? = "INV2-29Z4-EB7M-MUCY-327J"

    let sbPath = CkoStringBuilder()!
    sbPath.append(value: "/v1/invoicing/invoices/")
    sbPath.append(value: invoiceId)

    // Send the DELETE request and get the JSON response.
    let sbJsonResponse = CkoStringBuilder()!
    success = rest.fullRequestNoBodySb(httpVerb: "DELETE", uriPath: sbPath.getAsString(), sb: sbJsonResponse)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // A 204 response is expected for success.
    print("Response Status Code = \(rest.responseStatusCode.intValue)")

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

    print("Received successful 204 status code response.")
    print("There is no response body, as expected.")
    print("Success.")

}