Swift

PayPal - Refund Captured Payment

See more PayPal Examples

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

Note: This example requires Chilkat v9.5.0.65 or greater.

Swift

func chilkatTest() {
    var success: Bool = false

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

    // To refund a particular amount, build JSON such as this:
    let json = CkoJsonObject()!
    json.emitCompact = false
    json.updateString(jsonPath: "amount.total", value: "4.54")
    json.updateString(jsonPath: "amount.currency", value: "USD")
    json.updateString(jsonPath: "description", value: "Athletic socks")
    json.updateString(jsonPath: "reason", value: "Refunding because color was incorrect")
    print("\(json.emit()!)")

    // The JSON:

    // 	{ 
    // 	  "amount": { 
    // 	    "total": "4.54",
    // 	    "currency": "USD"
    // 	  },
    // 	  "description": "Athletic socks",
    // 	  "reason": "Refunding because color was incorrect"
    // 	}
    // 
    rest.addHeader(name: "Authorization", value: sbAuth.getAsString())
    rest.addHeader(name: "Content-Type", value: "application/json")

    // The capture ID is added to the path.
    // To list your captures: Find Captures. 
    let sbPath = CkoStringBuilder()!
    sbPath.append(value: "/v1/payments/capture/capture_id/refund")
    var numReplaced: Int = sbPath.replace(value: "capture_id", replacement: "1LY5310469661362J").intValue

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

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

    json.emitCompact = false
    json.loadSb(sb: 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": "77B77607RR7243500",
    // 	  "create_time": "2016-11-27T01:38:25Z",
    // 	  "update_time": "2016-11-27T01:38:25Z",
    // 	  "state": "completed",
    // 	  "amount": { 
    // 	    "total": "4.54",
    // 	    "currency": "USD"
    // 	  },
    // 	  "capture_id": "1LY5310469661362J",
    // 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    // 	  "links": [
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
    // 	      "rel": "self",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
    // 	      "rel": "parent_payment",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
    // 	      "rel": "capture",
    // 	      "method": "GET"
    // 	    }
    // 	  ]
    // 	}

}