Sample code for 30+ languages & platforms
Rust

PayPal Create Invoice

See more PayPal Examples

Creates a draft invoice.

Chilkat Rust Downloads

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..
// ----------------------------------------------------------------------------------------------

// First create a JSON invoice:
let json = chilkat::JsonObject::new();
json.set_emit_compact(false);
let _ = json.update_string("merchant_info.email", "frank-facilitator@example.com");
let _ = json.update_string("merchant_info.first_name", "Frank");
let _ = json.update_string("merchant_info.last_name", "Facilitator");
let _ = json.update_string("merchant_info.business_name", "Medical Professionals, LLC");
let _ = json.update_string("merchant_info.phone.country_code", "001");
let _ = json.update_string("merchant_info.phone.national_number", "5032141716");
let _ = json.update_string("merchant_info.address.line1", "1234 Main St.");
let _ = json.update_string("merchant_info.address.city", "Portland");
let _ = json.update_string("merchant_info.address.state", "OR");
let _ = json.update_string("merchant_info.address.postal_code", "97217");
let _ = json.update_string("merchant_info.address.country_code", "US");
let _ = json.update_string("billing_info[0].email", "frank-buyer@somewhere.com");
let _ = json.update_string("items[0].name", "Sutures");
let _ = json.update_int("items[0].quantity", 100);
let _ = json.update_string("items[0].unit_price.currency", "USD");
let _ = json.update_string("items[0].unit_price.value", "5");
let _ = json.update_string("note", "Medical Invoice 16 Jul, 2013 PST");
let _ = json.update_string("payment_term.term_type", "NET_45");
let _ = json.update_string("shipping_info.first_name", "Sally");
let _ = json.update_string("shipping_info.last_name", "Patient");
let _ = json.update_string("shipping_info.business_name", "Not applicable");
let _ = json.update_string("shipping_info.phone.country_code", "001");
let _ = json.update_string("shipping_info.phone.national_number", "5039871234");
let _ = json.update_string("shipping_info.address.line1", "1234 Broad St.");
let _ = json.update_string("shipping_info.address.city", "Portland");
let _ = json.update_string("shipping_info.address.state", "OR");
let _ = json.update_string("shipping_info.address.postal_code", "97216");
let _ = json.update_string("shipping_info.address.country_code", "US");

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

// The JSON invoice created by the above code:

// 	{ 
// 	  "merchant_info": { 
// 	    "email": "frank-facilitator@example.com",
// 	    "first_name": "Frank",
// 	    "last_name": "Facilitator",
// 	    "business_name": "Medical Professionals, LLC",
// 	    "phone": { 
// 	      "country_code": "001",
// 	      "national_number": "5032141716"
// 	    },
// 	    "address": { 
// 	      "line1": "1234 Main St.",
// 	      "city": "Portland",
// 	      "state": "OR",
// 	      "postal_code": "97217",
// 	      "country_code": "US"
// 	    }
// 	  },
// 	  "billing_info": [ 
// 	    { 
// 	      "email": "frank-buyer@somewhere.com"
// 	    }
// 	  ],
// 	  "items": [ 
// 	    { 
// 	      "name": "Sutures",
// 	      "quantity": 100,
// 	      "unit_price": { 
// 	        "currency": "USD",
// 	        "value": "5"
// 	      }
// 	    }
// 	  ],
// 	  "note": "Medical Invoice 16 Jul, 2013 PST",
// 	  "payment_term": { 
// 	    "term_type": "NET_45"
// 	  },
// 	  "shipping_info": { 
// 	    "first_name": "Sally",
// 	    "last_name": "Patient",
// 	    "business_name": "Not applicable",
// 	    "phone": { 
// 	      "country_code": "001",
// 	      "national_number": "5039871234"
// 	    },
// 	    "address": { 
// 	      "line1": "1234 Broad St.",
// 	      "city": "Portland",
// 	      "state": "OR",
// 	      "postal_code": "97216",
// 	      "country_code": "US"
// 	    }
// 	  }
// 	}

// Send the POST equivalent to this CURL command:

// 	curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/invoices/ \
// 	-H "Content-Type:application/json" \
// 	-H "Authorization: Bearer Access-Token" \
// 	-d '{ invoice JSON goes here }'

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", "/v1/invoicing/invoices", &sb_request_body, &sb_response_body).is_err() {
    println!("{}", rest.last_error_text());
    return;
}

// We should have some sort of JSON response.  It could be successful, or an error.
let json_response = chilkat::JsonObject::new();
json_response.set_emit_compact(false);
let _ = json_response.load_sb(&sb_response_body);

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

// Did we get a 201 success response?
if rest.response_status_code() != 201 {
    // Show the JSON response body
    println!("{}", json_response.emit().unwrap_or_default());

    println!("{}", rest.last_request_start_line());
    println!("{}", rest.last_request_header());
    println!("Failed.");
    return;
}

// Show a few parts of the JSON response
println!("id: {}", json_response.string_of("id").unwrap_or_default());
println!("number: {}", json_response.string_of("number").unwrap_or_default());
println!("template_id: {}", json_response.string_of("template_id").unwrap_or_default());
println!("status: {}", json_response.string_of("status").unwrap_or_default());

// Show the full JSON response.
println!("{}", json_response.emit().unwrap_or_default());
println!("Success.");

// A successful response looks like this:

// 	{ 
// 	  "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
// 	  "number": "0001",
// 	  "template_id": "TEMP-8HS37702UW384535K",
// 	  "status": "DRAFT",
// 	  "merchant_info": { 
// 	    "email": "smith-facilitator@chilkatsoft.com",
// 	    "first_name": "Joe",
// 	    "last_name": "Facilitator",
// 	    "business_name": "Medical Professionals, LLC",
// 	    "phone": { 
// 	      "country_code": "001",
// 	      "national_number": "5032141716"
// 	    },
// 	    "address": { 
// 	      "line1": "1234 Main St.",
// 	      "city": "Portland",
// 	      "state": "OR",
// 	      "postal_code": "97217",
// 	      "country_code": "US"
// 	    }
// 	  },
// 	  "billing_info": [ 
// 	    { 
// 	      "email": "smith-buyer@chilkatsoft.com"
// 	    }
// 	  ],
// 	  "shipping_info": { 
// 	    "first_name": "Sally",
// 	    "last_name": "Patient",
// 	    "business_name": "Not applicable",
// 	    "phone": { 
// 	      "country_code": "001",
// 	      "national_number": "5039871234"
// 	    },
// 	    "address": { 
// 	      "line1": "1234 Broad St.",
// 	      "city": "Portland",
// 	      "state": "OR",
// 	      "postal_code": "97216",
// 	      "country_code": "US"
// 	    }
// 	  },
// 	  "items": [ 
// 	    { 
// 	      "name": "Sutures",
// 	      "quantity": 100.0,
// 	      "unit_price": { 
// 	        "currency": "USD",
// 	        "value": "5.00"
// 	      }
// 	    }
// 	  ],
// 	  "invoice_date": "2016-11-15 PST",
// 	  "payment_term": { 
// 	    "term_type": "NET_45",
// 	    "due_date": "2016-12-30 PST"
// 	  },
// 	  "tax_calculated_after_discount": false,
// 	  "tax_inclusive": false,
// 	  "note": "Medical Invoice 16 Jul, 2013 PST",
// 	  "total_amount": { 
// 	    "currency": "USD",
// 	    "value": "500.00"
// 	  },
// 	  "metadata": { 
// 	    "created_date": "2016-11-15 06:17:03 PST"
// 	  },
// 	  "links": [ 
// 	    { 
// 	      "rel": "self",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "rel": "send",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/send",
// 	      "method": "POST"
// 	    },
// 	    { 
// 	      "rel": "update",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
// 	      "method": "PUT"
// 	    },
// 	    { 
// 	      "rel": "delete",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// 	      "method": "DELETE"
// 	    }
// 	  ]
// 	}
//