Swift

PayPal - Get Refund Details

See more PayPal Examples

Shows details for a refund, by ID.

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

    // Clear the REST object of any headers or query params from previous requests.
    rest.clearAllHeaders()
    rest.clearAllQueryParams()

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

    // The refund ID is added to the path.
    // To list your refunds, Find Completed Sales. 
    // Refunds in the list have a sale object with a state of "refunded" and a refund object with a state of "completed".
    let sbPath = CkoStringBuilder()!
    sbPath.append(value: "/v1/payments/refund/refund_id")
    var numReplaced: Int = sbPath.replace(value: "refund_id", replacement: "7NE550583A133505U").intValue

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

    let json = CkoJsonObject()!
    json.emitCompact = false
    json.loadSb(sb: sbJsonResponse)

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

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

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

    print("success")

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

    // 	{ 
    // 	  "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"
    // 	    }
    // 	  ]
    // 	}

}