Rust

PayPal - Refund Sale

See more PayPal Examples

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

Rust

// Note: Requires Chilkat v9.5.0.64 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..
// ----------------------------------------------------------------------------------------------

// To refund a particular amount, build JSON such as this:
let json_partial = chilkat::JsonObject::new();
json_partial.set_emit_compact(false);
let _ = json_partial.update_string("amount.total", "2.34");
let _ = json_partial.update_string("amount.currency", "USD");
// invoice_number is optional..
let _ = json_partial.update_string("invoice_number", "INV-1234567");
println!("{}", json_partial.emit().unwrap_or_default());

// The JSON for a partial refund:

// 	{ 
// 	  "amount": { 
// 	    "total": "2.34",
// 	    "currency": "USD"
// 	  },
// 	  "invoice_number": "INV-1234567"
// 	}

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

// The sale ID is added to the path.
// The sale ID is obtained from payment records as shown here: Find Completed Sales
let sb_path = chilkat::StringBuilder::new();
let _ = sb_path.append("/v1/payments/sale/sale_id/refund");
let num_replaced = sb_path.replace("sale_id", "1XC17935MN507400J");

// Send the POST request containign the JSON in the request body, and get the JSON response.
let sb_json_request = chilkat::StringBuilder::new();
json_partial.set_emit_compact(true);
let _ = json_partial.emit_sb(&sb_json_request);
let sb_json_response = chilkat::StringBuilder::new();

let b_full_refund = true;
// To send a full refund, send an empty request body:
if b_full_refund {
    sb_json_request.clear();
    let _ = sb_json_request.append("{}");
}

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

let json = chilkat::JsonObject::new();
json.set_emit_compact(false);
let _ = json.load_sb(&sb_json_response);

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

// Did we get a 201 success response?
if rest.response_status_code() != 201 {
    println!("{}", json.emit().unwrap_or_default());
    println!("Failed.");
    return;
}

println!("{}", json.emit().unwrap_or_default());
println!("Success.");

// A successful JSON response:
// The "id" is the refund_id.

// 	{ 
// 	  "id": "7NE550583A133505U",
// 	  "create_time": "2016-11-26T16:38:27Z",
// 	  "update_time": "2016-11-26T16:38:27Z",
// 	  "state": "completed",
// 	  "amount": { 
// 	    "total": "289.00",
// 	    "currency": "USD"
// 	  },
// 	  "sale_id": "1XC17935MN507400J",
// 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
// 	      "rel": "sale",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}