Xbase++

PayPal - Cancel Sent Invoice

See more PayPal Examples

Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and Cc: emails.

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 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
oJson:UpdateString("subject", "Past due")
oJson:UpdateString("note", "Canceling invoice")
oJson:UpdateBool("send_to_merchant", 1)
oJson:UpdateBool("send_to_payer", 1)
? oJson:Emit()

//  The JSON created by the above code:

//  	{ 
//  	  "subject": "Past due",
//  	  "note": "Canceling invoice",
//  	  "send_to_merchant": true,
//  	  "send_to_payer": true
//  	}

//  Build a path using a previously-sent invoice ID.
oSbPath := CreateObject("Chilkat.StringBuilder")
oSbPath:Append("/v1/invoicing/invoices/invoice_id/cancel")
nNumReplacements := oSbPath:Replace("invoice_id", "INV2-XPWZ-NUTQ-LNWB-P8NC")

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()
    oSbPath:destroy()
    oSbRequestBody:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

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

//  In our testing, we received a 204 response, which is a success HTTP response code, but 
//  differs from the PayPal REST API reference documentation, which states that a 202 response
//  is expected.  I suspect an error in the PayPal documentation, or in the PayPal responder.
//  Check for either 202 or 204..
//  Did we get a 202 accepted response?
IF ((oRest:ResponseStatusCode != 202) .AND. (oRest:ResponseStatusCode != 204))
    ? oSbResponseBody:GetAsString()
    ? "Failed."
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oJson:destroy()
    oSbPath:destroy()
    oSbRequestBody:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

//  The 202/204 response should be empty.  (Again, our experience differs from the online PayPal documentation..)
? "Success."

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