Xbase++

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded.

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

Xbase++

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oSbAuth
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oJson
LOCAL oDtNow
LOCAL oSbDt
LOCAL nNumReplaced
LOCAL oSbPath
LOCAL nNumReplacements
LOCAL oSbRequestBody
LOCAL oSbResponseBody

nSuccess := 0

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

//  Build the JSON request body containing the reminder information:
oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0
oDtNow := CreateObject("Chilkat.CkDateTime")
oDtNow:SetFromCurrentSystemTime()
oSbDt := CreateObject("Chilkat.StringBuilder")
oSbDt:Append(oDtNow:GetAsTimestamp(0))
nNumReplaced := oSbDt:Replace("T", " ")
nNumReplaced := oSbDt:Replace("Z", " UTC")
oJson:UpdateString("date", oSbDt:GetAsString())
oJson:UpdateString("note", "Refunded by credit card!")
oJson:UpdateString("amount.currency", "USD")
oJson:UpdateString("amount.value", "500.00")
? oJson:Emit()

//  The JSON created by the above code:

//  	{ 
//  	  "date": "2016-11-28 21:05:38 UTC",
//  	  "note": "Refunded by credit card!",
//  	  "amount": { 
//  	    "currency": "USD",
//  	    "value": "500.00"
//  	  }
//  	}

//  Build a path using a previously-sent invoice ID.
oSbPath := CreateObject("Chilkat.StringBuilder")
oSbPath:Append("/v1/invoicing/invoices/invoice_id/record-refund")
nNumReplacements := oSbPath:Replace("invoice_id", "INV2-QCHR-QHSD-M2VU-AVXC")

oJson:EmitCompact := 1
oSbRequestBody := CreateObject("Chilkat.StringBuilder")
oSbResponseBody := CreateObject("Chilkat.StringBuilder")

oRest:AddHeader("Content-Type", "application/json")
oRest:AddHeader("Authorization", oSbAuth:GetAsString())
oJson:EmitSb(oSbRequestBody)

nSuccess := oRest:FullRequestSb("POST", oSbPath:GetAsString(), oSbRequestBody, oSbResponseBody)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oJson:destroy()
    oDtNow:destroy()
    oSbDt:destroy()
    oSbPath:destroy()
    oSbRequestBody:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

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

//  Check for a success response.
IF (oRest:ResponseStatusCode != 204)
    ? oSbResponseBody:GetAsString()
    ? "Failed."
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oJson:destroy()
    oDtNow:destroy()
    oSbDt:destroy()
    oSbPath:destroy()
    oSbRequestBody:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

//  For a success response, the response body is empty.
? "Success."

oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oJson:destroy()
oDtNow:destroy()
oSbDt:destroy()
oSbPath:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()