C#

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.

C#

bool success = false;

// 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)
Chilkat.JsonObject jsonToken = new Chilkat.JsonObject();
jsonToken.LoadFile("qa_data/tokens/paypal.json");

// Build the Authorization request header field value.
Chilkat.StringBuilder sbAuth = new Chilkat.StringBuilder();
// token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf("token_type"));
sbAuth.Append(" ");
sbAuth.Append(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.
Chilkat.Rest rest = new Chilkat.Rest();
bool bAutoReconnect = true;
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

// ----------------------------------------------------------------------------------------------
// 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:
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.EmitCompact = false;
json.UpdateString("subject","Past due");
json.UpdateString("note","Canceling invoice");
json.UpdateBool("send_to_merchant",true);
json.UpdateBool("send_to_payer",true);
Debug.WriteLine(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.
Chilkat.StringBuilder sbPath = new Chilkat.StringBuilder();
sbPath.Append("/v1/invoicing/invoices/invoice_id/cancel");
int numReplacements = sbPath.Replace("invoice_id","INV2-XPWZ-NUTQ-LNWB-P8NC");

json.EmitCompact = true;
Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();

rest.AddHeader("Content-Type","application/json");
rest.AddHeader("Authorization",sbAuth.GetAsString());
json.EmitSb(sbRequestBody);

success = rest.FullRequestSb("POST",sbPath.GetAsString(),sbRequestBody,sbResponseBody);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

Debug.WriteLine("Response Status Code = " + Convert.ToString(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 ((rest.ResponseStatusCode != 202) && (rest.ResponseStatusCode != 204)) {
    Debug.WriteLine(sbResponseBody.GetAsString());
    Debug.WriteLine("Failed.");
    return;
}

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