(Visual FoxPro) PayPal - Mark Invoice as Refunded

Mark an invoice as refunded.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loJsonToken
LOCAL loSbAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lnSuccess
LOCAL loJson
LOCAL loDtNow
LOCAL loSbDt
LOCAL lnNumReplaced
LOCAL loSbPath
LOCAL lnNumReplacements
LOCAL loSbRequestBody
LOCAL loSbResponseBody

* 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)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

* Build the Authorization request header field value.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbAuth = CreateObject('Chilkat.StringBuilder')
* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.Rest')
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("api.sandbox.paypal.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    CANCEL
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:
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.CkDateTime')
loDtNow = CreateObject('Chilkat.CkDateTime')
loDtNow.SetFromCurrentSystemTime()
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbDt = CreateObject('Chilkat.StringBuilder')
loSbDt.Append(loDtNow.GetAsTimestamp(0))
lnNumReplaced = loSbDt.Replace("T"," ")
lnNumReplaced = loSbDt.Replace("Z"," UTC")
loJson.UpdateString("date",loSbDt.GetAsString())
loJson.UpdateString("note","Refunded by credit card!")
loJson.UpdateString("amount.currency","USD")
loJson.UpdateString("amount.value","500.00")
? loJson.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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/v1/invoicing/invoices/invoice_id/record-refund")
lnNumReplacements = loSbPath.Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC")

loJson.EmitCompact = 1
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')

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

lnSuccess = loRest.FullRequestSb("POST",loSbPath.GetAsString(),loSbRequestBody,loSbResponseBody)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loJson
    RELEASE loDtNow
    RELEASE loSbDt
    RELEASE loSbPath
    RELEASE loSbRequestBody
    RELEASE loSbResponseBody
    CANCEL
ENDIF

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

* Check for a success response.
IF (loRest.ResponseStatusCode <> 204) THEN
    ? loSbResponseBody.GetAsString()
    ? "Failed."
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loJson
    RELEASE loDtNow
    RELEASE loSbDt
    RELEASE loSbPath
    RELEASE loSbRequestBody
    RELEASE loSbResponseBody
    CANCEL
ENDIF

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

RELEASE loJsonToken
RELEASE loSbAuth
RELEASE loRest
RELEASE loJson
RELEASE loDtNow
RELEASE loSbDt
RELEASE loSbPath
RELEASE loSbRequestBody
RELEASE loSbResponseBody