Rust

PayPal - Refund Captured Payment

See more PayPal Examples

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

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 = chilkat::JsonObject::new();
json.set_emit_compact(false);
let _ = json.update_string("amount.total", "4.54");
let _ = json.update_string("amount.currency", "USD");
let _ = json.update_string("description", "Athletic socks");
let _ = json.update_string("reason", "Refunding because color was incorrect");
println!("{}", json.emit().unwrap_or_default());

// The JSON:

// 	{ 
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "description": "Athletic socks",
// 	  "reason": "Refunding because color was incorrect"
// 	}
// 
let _ = rest.add_header("Authorization", &sb_auth.get_as_string().unwrap_or_default());
let _ = rest.add_header("Content-Type", "application/json");

// The capture ID is added to the path.
// To list your captures: Find Captures. 
let sb_path = chilkat::StringBuilder::new();
let _ = sb_path.append("/v1/payments/capture/capture_id/refund");
let num_replaced = sb_path.replace("capture_id", "1LY5310469661362J");

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

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;
}

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": "77B77607RR7243500",
// 	  "create_time": "2016-11-27T01:38:25Z",
// 	  "update_time": "2016-11-27T01:38:25Z",
// 	  "state": "completed",
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "capture_id": "1LY5310469661362J",
// 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
// 	      "rel": "capture",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}