(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

// 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)
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loSbAuth = createobject("CkStringBuilder")
// token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.StringOf("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.
loRest = createobject("CkRest")
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.sandbox.paypal.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    return
endif

// ----------------------------------------------------------------------------------------------
// 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:
loJsonPartial = createobject("CkJsonObject")
loJsonPartial.EmitCompact = .F.
loJsonPartial.UpdateString("amount.total","2.34")
loJsonPartial.UpdateString("amount.currency","USD")
// invoice_number is optional..
loJsonPartial.UpdateString("invoice_number","INV-1234567")
? loJsonPartial.Emit()

// The JSON for a partial refund:

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

loRest.AddHeader("Authorization",loSbAuth.GetAsString())
loRest.AddHeader("Content-Type","application/json")

// The sale ID is added to the path.
// The sale ID is obtained from payment records as shown here: Find Completed Sales
loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/v1/payments/sale/sale_id/refund")
lnNumReplaced = loSbPath.Replace("sale_id","1XC17935MN507400J")

// Send the POST request containign the JSON in the request body, and get the JSON response.
loSbJsonRequest = createobject("CkStringBuilder")
loJsonPartial.EmitCompact = .T.
loJsonPartial.EmitSb(loSbJsonRequest)
loSbJsonResponse = createobject("CkStringBuilder")

llBFullRefund = .T.
// To send a full refund, send an empty request body:
if (llBFullRefund = .T.) then
    loSbJsonRequest.Clear()
    loSbJsonRequest.Append("{}")
endif

llSuccess = loRest.FullRequestSb("POST",loSbPath.GetAsString(),loSbJsonRequest,loSbJsonResponse)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    release loJsonPartial
    release loSbPath
    release loSbJsonRequest
    release loSbJsonResponse
    return
endif

loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.
loJson.LoadSb(loSbJsonResponse)

? "Response Status Code = " + str(loRest.ResponseStatusCode)

// Did we get a 201 success response?
if (loRest.ResponseStatusCode <> 201) then
    ? loJson.Emit()
    ? "Failed."
    release loJsonToken
    release loSbAuth
    release loRest
    release loJsonPartial
    release loSbPath
    release loSbJsonRequest
    release loSbJsonResponse
    release loJson
    return
endif

? loJson.Emit()
? "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"
// 	    }
// 	  ]
// 	}


release loJsonToken
release loSbAuth
release loRest
release loJsonPartial
release loSbPath
release loSbJsonRequest
release loSbJsonResponse
release loJson