Xbase++

PayPal - Refund Sale

See more PayPal Examples

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.

Xbase++

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oSbAuth
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oJsonPartial
LOCAL oSbPath
LOCAL nNumReplaced
LOCAL oSbJsonRequest
LOCAL oSbJsonResponse
LOCAL nBFullRefund
LOCAL oJson

nSuccess := 0

//  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)
oJsonToken := CreateObject("Chilkat.JsonObject")
oJsonToken:LoadFile("qa_data/tokens/paypal.json")

//  Build the Authorization request header field value.
oSbAuth := CreateObject("Chilkat.StringBuilder")
//  token_type should be "Bearer"
oSbAuth:Append(oJsonToken:StringOf("token_type"))
oSbAuth:Append(" ")
oSbAuth:Append(oJsonToken: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.
oRest := CreateObject("Chilkat.Rest")
nBAutoReconnect := 1
nSuccess := oRest:Connect("api.sandbox.paypal.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    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:
oJsonPartial := CreateObject("Chilkat.JsonObject")
oJsonPartial:EmitCompact := 0
oJsonPartial:UpdateString("amount.total", "2.34")
oJsonPartial:UpdateString("amount.currency", "USD")
//  invoice_number is optional..
oJsonPartial:UpdateString("invoice_number", "INV-1234567")
? oJsonPartial:Emit()

//  The JSON for a partial refund:

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

oRest:AddHeader("Authorization", oSbAuth:GetAsString())
oRest: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
oSbPath := CreateObject("Chilkat.StringBuilder")
oSbPath:Append("/v1/payments/sale/sale_id/refund")
nNumReplaced := oSbPath:Replace("sale_id", "1XC17935MN507400J")

//  Send the POST request containign the JSON in the request body, and get the JSON response.
oSbJsonRequest := CreateObject("Chilkat.StringBuilder")
oJsonPartial:EmitCompact := 1
oJsonPartial:EmitSb(oSbJsonRequest)
oSbJsonResponse := CreateObject("Chilkat.StringBuilder")

nBFullRefund := 1
//  To send a full refund, send an empty request body:
IF (nBFullRefund == 1)
    oSbJsonRequest:Clear()
    oSbJsonRequest:Append("{}")
ENDIF

nSuccess := oRest:FullRequestSb("POST", oSbPath:GetAsString(), oSbJsonRequest, oSbJsonResponse)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oJsonPartial:destroy()
    oSbPath:destroy()
    oSbJsonRequest:destroy()
    oSbJsonResponse:destroy()
    RETURN
ENDIF

oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0
oJson:LoadSb(oSbJsonResponse)

? "Response Status Code = " + Str(oRest:ResponseStatusCode)

//  Did we get a 201 success response?
IF (oRest:ResponseStatusCode != 201)
    ? oJson:Emit()
    ? "Failed."
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oJsonPartial:destroy()
    oSbPath:destroy()
    oSbJsonRequest:destroy()
    oSbJsonResponse:destroy()
    oJson:destroy()
    RETURN
ENDIF

? oJson: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"
//  	    }
//  	  ]
//  	}

oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oJsonPartial:destroy()
oSbPath:destroy()
oSbJsonRequest:destroy()
oSbJsonResponse:destroy()
oJson:destroy()