PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_Json
oleobject loo_SbPath
integer li_NumReplacements
oleobject loo_SbRequestBody
oleobject loo_SbResponseBody

li_Success = 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)
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonToken
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loo_SbAuth = create oleobject
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")

// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_JsonToken.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.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")

li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    return
end if

// ----------------------------------------------------------------------------------------------
// 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:
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.EmitCompact = 0
loo_Json.UpdateString("subject","Past due")
loo_Json.UpdateString("note","Canceling invoice")
loo_Json.UpdateBool("send_to_merchant",1)
loo_Json.UpdateBool("send_to_payer",1)
Write-Debug loo_Json.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.
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("/v1/invoicing/invoices/invoice_id/cancel")
li_NumReplacements = loo_SbPath.Replace("invoice_id","INV2-XPWZ-NUTQ-LNWB-P8NC")

loo_Json.EmitCompact = 1
loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Rest.AddHeader("Content-Type","application/json")
loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Json.EmitSb(loo_SbRequestBody)

li_Success = loo_Rest.FullRequestSb("POST",loo_SbPath.GetAsString(),loo_SbRequestBody,loo_SbResponseBody)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_SbRequestBody
    destroy loo_SbResponseBody
    return
end if

Write-Debug "Response Status Code = " + string(loo_Rest.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 (loo_Rest.ResponseStatusCode <> 202) AND (loo_Rest.ResponseStatusCode <> 204) then
    Write-Debug loo_SbResponseBody.GetAsString()
    Write-Debug "Failed."
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_SbRequestBody
    destroy loo_SbResponseBody
    return
end if

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


destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbPath
destroy loo_SbRequestBody
destroy loo_SbResponseBody