Rust

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.

Rust

// 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)
let json_token = chilkat::JsonObject::new();
let _ = json_token.load_file("qa_data/tokens/paypal.json");

// Build the Authorization request header field value.
let sb_auth = chilkat::StringBuilder::new();
// token_type should be "Bearer"
let _ = sb_auth.append(&json_token.string_of("token_type").unwrap_or_default());
let _ = sb_auth.append(" ");
let _ = sb_auth.append(&json_token.string_of("access_token").unwrap_or_default());

// 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.
let rest = chilkat::Rest::new();
let b_auto_reconnect = true;
if rest.connect("api.sandbox.paypal.com", 443, true, b_auto_reconnect).is_err() {
    println!("{}", rest.last_error_text());
    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:
let json = chilkat::JsonObject::new();
json.set_emit_compact(false);
let _ = json.update_string("subject", "Past due");
let _ = json.update_string("note", "Canceling invoice");
let _ = json.update_bool("send_to_merchant", true);
let _ = json.update_bool("send_to_payer", true);
println!("{}", json.emit().unwrap_or_default());

// 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.
let sb_path = chilkat::StringBuilder::new();
let _ = sb_path.append("/v1/invoicing/invoices/invoice_id/cancel");
let num_replacements = sb_path.replace("invoice_id", "INV2-XPWZ-NUTQ-LNWB-P8NC");

json.set_emit_compact(true);
let sb_request_body = chilkat::StringBuilder::new();
let sb_response_body = chilkat::StringBuilder::new();

let _ = rest.add_header("Content-Type", "application/json");
let _ = rest.add_header("Authorization", &sb_auth.get_as_string().unwrap_or_default());
let _ = json.emit_sb(&sb_request_body);

if rest.full_request_sb("POST", &sb_path.get_as_string().unwrap_or_default(), &sb_request_body, &sb_response_body).is_err() {
    println!("{}", rest.last_error_text());
    return;
}

println!("Response Status Code = {}", rest.response_status_code());

// 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.response_status_code() != 202) && (rest.response_status_code() != 204) {
    println!("{}", sb_response_body.get_as_string().unwrap_or_default());
    println!("Failed.");
    return;
}

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