Unicode C
Unicode C
PayPal Create Invoice
See more PayPal Examples
Creates a draft invoice.Chilkat Unicode C Downloads
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkRestW.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObjectW jsonToken;
HCkStringBuilderW sbAuth;
HCkRestW rest;
BOOL bAutoReconnect;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jsonResponse;
success = FALSE;
// 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)
jsonToken = CkJsonObjectW_Create();
CkJsonObjectW_LoadFile(jsonToken,L"qa_data/tokens/paypal.json");
// Build the Authorization request header field value.
sbAuth = CkStringBuilderW_Create();
// token_type should be "Bearer"
CkStringBuilderW_Append(sbAuth,CkJsonObjectW_stringOf(jsonToken,L"token_type"));
CkStringBuilderW_Append(sbAuth,L" ");
CkStringBuilderW_Append(sbAuth,CkJsonObjectW_stringOf(jsonToken,L"access_token"));
// 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.
rest = CkRestW_Create();
bAutoReconnect = TRUE;
success = CkRestW_Connect(rest,L"api.sandbox.paypal.com",443,TRUE,bAutoReconnect);
if (success != TRUE) {
wprintf(L"%s\n",CkRestW_lastErrorText(rest));
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
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:
json = CkJsonObjectW_Create();
CkJsonObjectW_putEmitCompact(json,FALSE);
CkJsonObjectW_UpdateString(json,L"merchant_info.email",L"frank-facilitator@example.com");
CkJsonObjectW_UpdateString(json,L"merchant_info.first_name",L"Frank");
CkJsonObjectW_UpdateString(json,L"merchant_info.last_name",L"Facilitator");
CkJsonObjectW_UpdateString(json,L"merchant_info.business_name",L"Medical Professionals, LLC");
CkJsonObjectW_UpdateString(json,L"merchant_info.phone.country_code",L"001");
CkJsonObjectW_UpdateString(json,L"merchant_info.phone.national_number",L"5032141716");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.line1",L"1234 Main St.");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.city",L"Portland");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.state",L"OR");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.postal_code",L"97217");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.country_code",L"US");
CkJsonObjectW_UpdateString(json,L"billing_info[0].email",L"frank-buyer@somewhere.com");
CkJsonObjectW_UpdateString(json,L"items[0].name",L"Sutures");
CkJsonObjectW_UpdateInt(json,L"items[0].quantity",100);
CkJsonObjectW_UpdateString(json,L"items[0].unit_price.currency",L"USD");
CkJsonObjectW_UpdateString(json,L"items[0].unit_price.value",L"5");
CkJsonObjectW_UpdateString(json,L"note",L"Medical Invoice 16 Jul, 2013 PST");
CkJsonObjectW_UpdateString(json,L"payment_term.term_type",L"NET_45");
CkJsonObjectW_UpdateString(json,L"shipping_info.first_name",L"Sally");
CkJsonObjectW_UpdateString(json,L"shipping_info.last_name",L"Patient");
CkJsonObjectW_UpdateString(json,L"shipping_info.business_name",L"Not applicable");
CkJsonObjectW_UpdateString(json,L"shipping_info.phone.country_code",L"001");
CkJsonObjectW_UpdateString(json,L"shipping_info.phone.national_number",L"5039871234");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.line1",L"1234 Broad St.");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.city",L"Portland");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.state",L"OR");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.postal_code",L"97216");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.country_code",L"US");
wprintf(L"%s\n",CkJsonObjectW_emit(json));
// 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 }'
CkJsonObjectW_putEmitCompact(json,TRUE);
sbRequestBody = CkStringBuilderW_Create();
sbResponseBody = CkStringBuilderW_Create();
CkRestW_AddHeader(rest,L"Content-Type",L"application/json");
CkRestW_AddHeader(rest,L"Authorization",CkStringBuilderW_getAsString(sbAuth));
CkJsonObjectW_EmitSb(json,sbRequestBody);
success = CkRestW_FullRequestSb(rest,L"POST",L"/v1/invoicing/invoices",sbRequestBody,sbResponseBody);
if (success != TRUE) {
wprintf(L"%s\n",CkRestW_lastErrorText(rest));
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
// We should have some sort of JSON response. It could be successful, or an error.
jsonResponse = CkJsonObjectW_Create();
CkJsonObjectW_putEmitCompact(jsonResponse,FALSE);
CkJsonObjectW_LoadSb(jsonResponse,sbResponseBody);
wprintf(L"Response Status Code = %d\n",CkRestW_getResponseStatusCode(rest));
// Did we get a 201 success response?
if (CkRestW_getResponseStatusCode(rest) != 201) {
// Show the JSON response body
wprintf(L"%s\n",CkJsonObjectW_emit(jsonResponse));
wprintf(L"%s\n",CkRestW_lastRequestStartLine(rest));
wprintf(L"%s\n",CkRestW_lastRequestHeader(rest));
wprintf(L"Failed.\n");
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jsonResponse);
return;
}
// Show a few parts of the JSON response
wprintf(L"id: %s\n",CkJsonObjectW_stringOf(jsonResponse,L"id"));
wprintf(L"number: %s\n",CkJsonObjectW_stringOf(jsonResponse,L"number"));
wprintf(L"template_id: %s\n",CkJsonObjectW_stringOf(jsonResponse,L"template_id"));
wprintf(L"status: %s\n",CkJsonObjectW_stringOf(jsonResponse,L"status"));
// Show the full JSON response.
wprintf(L"%s\n",CkJsonObjectW_emit(jsonResponse));
wprintf(L"Success.\n");
// 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"
// }
// ]
// }
//
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jsonResponse);
}