Zig
Zig
PayPal - Create Order
See more PayPal Examples
Creates a PayPal order."Creating a PayPal order indicates that the buyer has consented to the purchase but does not place the funds on hold. After you create an order, you can capture the order directly without any additional authorization or you can make an authorization API call to place funds on hold until you are ready to capture. Because the order does not place funds on hold, create an authorization instead of capturing an order directly.Merchants often use this technique to accept orders for items that are not available for shipment when the order is placed. For example, when a merchant ships items from multiple distribution centers and needs separate authorizations for each shipment. Another example would be delayed shipping on items that are not in stock."
See PayPal Order Process for more information.
Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
// 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)
const json_token = try chilkat.JsonObject.init();
defer json_token.deinit();
json_token.loadFile("qa_data/tokens/paypal.json") catch {};
// Build the Authorization request header field value.
const sb_auth = try chilkat.StringBuilder.init();
defer sb_auth.deinit();
// token_type should be "Bearer"
sb_auth.append(try json_token.stringOf(alloc, "token_type")) catch {};
sb_auth.append(" ") catch {};
sb_auth.append(try json_token.stringOf(alloc, "access_token")) catch {};
// 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.
const rest = try chilkat.Rest.init();
defer rest.deinit();
const b_auto_reconnect = true;
rest.connect("api.sandbox.paypal.com", 443, true, b_auto_reconnect) catch {
std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
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 containing the transaction information.
const json = try chilkat.JsonObject.init();
defer json.deinit();
json.setEmitCompact(false);
json.updateString("intent", "order") catch {};
json.updateString("payer.payment_method", "paypal") catch {};
json.updateString("transactions[0].amount.total", "30.11") catch {};
json.updateString("transactions[0].amount.currency", "USD") catch {};
json.updateString("transactions[0].amount.details.subtotal", "30.00") catch {};
json.updateString("transactions[0].amount.details.tax", "0.07") catch {};
json.updateString("transactions[0].amount.details.shipping", "0.03") catch {};
json.updateString("transactions[0].amount.details.handling_fee", "1.00") catch {};
json.updateString("transactions[0].amount.details.shipping_discount", "-1.00") catch {};
json.updateString("transactions[0].amount.details.insurance", "0.01") catch {};
json.updateString("transactions[0].description", "This is the payment transaction description.") catch {};
json.updateString("transactions[0].custom", "EBAY_EMS_90048630024435") catch {};
json.updateString("transactions[0].invoice_number", "48787589673") catch {};
json.updateString("transactions[0].payment_options.allowed_payment_method", "INSTANT_FUNDING_SOURCE") catch {};
json.updateString("transactions[0].soft_descriptor", "ECHI5786786") catch {};
json.updateString("transactions[0].item_list.items[0].name", "hat") catch {};
json.updateString("transactions[0].item_list.items[0].description", "Brown color hat") catch {};
json.updateString("transactions[0].item_list.items[0].quantity", "5") catch {};
json.updateString("transactions[0].item_list.items[0].price", "3") catch {};
json.updateString("transactions[0].item_list.items[0].tax", "0.01") catch {};
json.updateString("transactions[0].item_list.items[0].sku", "1") catch {};
json.updateString("transactions[0].item_list.items[0].currency", "USD") catch {};
json.updateString("transactions[0].item_list.items[1].name", "handbag") catch {};
json.updateString("transactions[0].item_list.items[1].description", "Black color hand bag") catch {};
json.updateString("transactions[0].item_list.items[1].quantity", "1") catch {};
json.updateString("transactions[0].item_list.items[1].price", "15") catch {};
json.updateString("transactions[0].item_list.items[1].tax", "0.02") catch {};
json.updateString("transactions[0].item_list.items[1].sku", "product34") catch {};
json.updateString("transactions[0].item_list.items[1].currency", "USD") catch {};
json.updateString("transactions[0].item_list.shipping_address.recipient_name", "Hello World") catch {};
json.updateString("transactions[0].item_list.shipping_address.line1", "4thFloor") catch {};
json.updateString("transactions[0].item_list.shipping_address.line2", "unit#34") catch {};
json.updateString("transactions[0].item_list.shipping_address.city", "SAn Jose") catch {};
json.updateString("transactions[0].item_list.shipping_address.country_code", "US") catch {};
json.updateString("transactions[0].item_list.shipping_address.postal_code", "95131") catch {};
json.updateString("transactions[0].item_list.shipping_address.phone", "011862212345678") catch {};
json.updateString("transactions[0].item_list.shipping_address.state", "CA") catch {};
json.updateString("note_to_payer", "Contact us for any questions on your order.") catch {};
json.updateString("redirect_urls.return_url", "http://www.amazon.com") catch {};
json.updateString("redirect_urls.cancel_url", "http://www.hawaii.com") catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// The JSON created by the above code:
// {
// "intent": "order",
// "payer": {
// "payment_method": "paypal"
// },
// "transactions": [
// {
// "amount": {
// "total": "30.11",
// "currency": "USD",
// "details": {
// "subtotal": "30.00",
// "tax": "0.07",
// "shipping": "0.03",
// "handling_fee": "1.00",
// "shipping_discount": "-1.00",
// "insurance": "0.01"
// }
// },
// "description": "This is the payment transaction description.",
// "custom": "EBAY_EMS_90048630024435",
// "invoice_number": "48787589673",
// "payment_options": {
// "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
// },
// "soft_descriptor": "ECHI5786786",
// "item_list": {
// "items": [
// {
// "name": "hat",
// "description": "Brown color hat",
// "quantity": "5",
// "price": "3",
// "tax": "0.01",
// "sku": "1",
// "currency": "USD"
// },
// {
// "name": "handbag",
// "description": "Black color hand bag",
// "quantity": "1",
// "price": "15",
// "tax": "0.02",
// "sku": "product34",
// "currency": "USD"
// }
// ],
// "shipping_address": {
// "recipient_name": "Hello World",
// "line1": "4thFloor",
// "line2": "unit#34",
// "city": "SAn Jose",
// "country_code": "US",
// "postal_code": "95131",
// "phone": "011862212345678",
// "state": "CA"
// }
// }
// }
// ],
// "note_to_payer": "Contact us for any questions on your order.",
// "redirect_urls": {
// "return_url": "http://www.amazon.com",
// "cancel_url": "http://www.hawaii.com"
// }
// }
//
rest.addHeader("Authorization", try sb_auth.getAsString(alloc)) catch {};
rest.addHeader("Content-Type", "application/json") catch {};
// Send the POST request containign the JSON in the request body, and get the JSON response.
const sb_json_request = try chilkat.StringBuilder.init();
defer sb_json_request.deinit();
json.setEmitCompact(true);
json.emitSb(sb_json_request) catch {};
const sb_json_response = try chilkat.StringBuilder.init();
defer sb_json_response.deinit();
rest.fullRequestSb("POST", "/v1/payments/payment", sb_json_request, sb_json_response) catch {
std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
return;
};
json.setEmitCompact(false);
json.loadSb(sb_json_response) catch {};
std.debug.print("Response Status Code = {d}\n", .{rest.getResponseStatusCode()});
// Did we get a 201 success response?
if (rest.getResponseStatusCode() != 201) {
std.debug.print("{s}\n", .{try json.emit(alloc)});
std.debug.print("Failed.\n", .{});
return;
}
// Sample JSON response is shown below.
std.debug.print("{s}\n", .{try json.emit(alloc)});
std.debug.print("success\n", .{});
// ------------------------------------------------
// A sample JSON response:
// {
// "id": "PAY-4G829619WD096761LLA3DYAQ",
// "intent": "order",
// "state": "created",
// "payer": {
// "payment_method": "paypal",
// "use_vendor_currency_conversion": false
// },
// "transactions": [
// {
// "amount": {
// "total": "30.11",
// "currency": "USD",
// "details": {
// "subtotal": "30.00",
// "tax": "0.07",
// "shipping": "0.03",
// "insurance": "0.01",
// "handling_fee": "1.00",
// "shipping_discount": "-1.00"
// }
// },
// "description": "This is the payment transaction description.",
// "custom": "EBAY_EMS_90048630024435",
// "invoice_number": "48787589673",
// "soft_descriptor": "ECHI5786786",
// "payment_options": {
// "allowed_payment_method": "INSTANT_FUNDING_SOURCE",
// "recurring_flag": false,
// "skip_fmf": false
// },
// "item_list": {
// "items": [
// {
// "name": "hat",
// "sku": "1",
// "description": "Brown color hat",
// "price": "3.00",
// "currency": "USD",
// "tax": "0.01",
// "quantity": 5
// },
// {
// "name": "handbag",
// "sku": "product34",
// "description": "Black color hand bag",
// "price": "15.00",
// "currency": "USD",
// "tax": "0.02",
// "quantity": 1
// }
// ],
// "shipping_address": {
// "recipient_name": "Hello World",
// "line1": "4thFloor",
// "line2": "unit#34",
// "city": "SAn Jose",
// "state": "CA",
// "postal_code": "95131",
// "country_code": "US",
// "phone": "011862212345678"
// }
// },
// "related_resources": [
// ]
// }
// ],
// "note_to_payer": "Contact us for any questions on your order.",
// "create_time": "2016-11-24T01:01:54Z",
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-4G829619WD096761LLA3DYAQ",
// "rel": "self",
// "method": "GET"
// },
// {
// "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0LS838292T986021B",
// "rel": "approval_url",
// "method": "REDIRECT"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-4G829619WD096761LLA3DYAQ/execute",
// "rel": "execute",
// "method": "POST"
// }
// ]
// }
}