Unicode C
Unicode C
PayPal List Merchant Invoices
See more PayPal Examples
List PayPal invoices.See also PayPal List Invoices REST API Reference
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;
HCkStringBuilderW sbJsonResponse;
HCkJsonObjectW json;
int numInvoices;
int i;
int j;
int numBillingInfo;
int numLinks;
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..
// ----------------------------------------------------------------------------------------------
CkRestW_AddHeader(rest,L"Authorization",CkStringBuilderW_getAsString(sbAuth));
CkRestW_AddQueryParam(rest,L"page",L"0");
CkRestW_AddQueryParam(rest,L"page_size",L"20");
CkRestW_AddQueryParam(rest,L"total_count_required",L"true");
// Send the GET request and get the JSON response.
sbJsonResponse = CkStringBuilderW_Create();
success = CkRestW_FullRequestNoBodySb(rest,L"GET",L"/v1/invoicing/invoices",sbJsonResponse);
if (success != TRUE) {
wprintf(L"%s\n",CkRestW_lastErrorText(rest));
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkStringBuilderW_Dispose(sbJsonResponse);
return;
}
json = CkJsonObjectW_Create();
CkJsonObjectW_putEmitCompact(json,FALSE);
CkJsonObjectW_LoadSb(json,sbJsonResponse);
wprintf(L"Response Status Code = %d\n",CkRestW_getResponseStatusCode(rest));
// Did we get a 200 success response?
if (CkRestW_getResponseStatusCode(rest) != 200) {
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"Failed.\n");
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkStringBuilderW_Dispose(sbJsonResponse);
CkJsonObjectW_Dispose(json);
return;
}
// Sample response JSON is shown below.
// Iterate over each invoice and get some information from each..
numInvoices = CkJsonObjectW_SizeOfArray(json,L"invoices");
i = 0;
while (i < numInvoices) {
CkJsonObjectW_putI(json,i);
wprintf(L"Invoice ID: %s\n",CkJsonObjectW_stringOf(json,L"invoices[i].id"));
wprintf(L"Invoice Number: %s\n",CkJsonObjectW_stringOf(json,L"invoices[i].number"));
wprintf(L"Invoice Status: %s\n",CkJsonObjectW_stringOf(json,L"invoices[i].status"));
wprintf(L"Shipping First Name: %s\n",CkJsonObjectW_stringOf(json,L"invoices[i].shipping_info.first_name"));
j = 0;
numBillingInfo = CkJsonObjectW_SizeOfArray(json,L"invoices[i].billing_info");
while (j < numBillingInfo) {
CkJsonObjectW_putJ(json,j);
wprintf(L"billing_info email: %s\n",CkJsonObjectW_stringOf(json,L"invoices[i].billing_info[j].email"));
j = j + 1;
}
numLinks = CkJsonObjectW_SizeOfArray(json,L"invoices[i].links");
j = 0;
while (j < numLinks) {
CkJsonObjectW_putJ(json,j);
wprintf(L"link: %s\n",CkJsonObjectW_stringOf(json,L"invoices[i].links[j].href"));
j = j + 1;
}
wprintf(L"----\n");
i = i + 1;
}
wprintf(L"Success.\n");
// {
// "total_count": 2,
// "invoices": [
// {
// "id": "INV2-XV4B-736P-PLVN-SZCE",
// "number": "0002",
// "status": "DRAFT",
// "merchant_info": {
// "email": "smith-facilitator@chilkatsoft.com"
// },
// "billing_info": [
// {
// "email": "smith-buyer@chilkatsoft.com"
// }
// ],
// "shipping_info": {
// "email": "smith-buyer@chilkatsoft.com",
// "first_name": "Sally",
// "last_name": "Patient",
// "business_name": "Not applicable"
// },
// "invoice_date": "2016-11-15 PST",
// "payment_term": {
// "due_date": "2016-12-30 PST"
// },
// "note": "Medical Invoice 16 Jul, 2013 PST",
// "total_amount": {
// "currency": "USD",
// "value": "500.00"
// },
// "metadata": {
// "created_date": "2016-11-15 08:09:21 PST"
// },
// "paid_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "refunded_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// "method": "GET"
// },
// {
// "rel": "send",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
// "method": "POST"
// },
// {
// "rel": "update",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
// "method": "PUT"
// },
// {
// "rel": "delete",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// "method": "DELETE"
// }
// ]
// },
// {
// "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
// "number": "0001",
// "status": "SENT",
// "merchant_info": {
// "email": "smith-facilitator@chilkatsoft.com"
// },
// "billing_info": [
// {
// "email": "smith-buyer@chilkatsoft.com"
// }
// ],
// "shipping_info": {
// "email": "smith-buyer@chilkatsoft.com",
// "first_name": "Sally",
// "last_name": "Patient",
// "business_name": "Not applicable"
// },
// "invoice_date": "2016-11-15 PST",
// "payment_term": {
// "due_date": "2016-12-30 PST"
// },
// "note": "Medical Invoice 16 Jul, 2013 PST",
// "total_amount": {
// "currency": "USD",
// "value": "500.00"
// },
// "metadata": {
// "created_date": "2016-11-15 06:17:03 PST",
// "payer_view_url": "https://www.sandbox.paypal.com/cgi_bin/webscr?cmd=_pay-inv&viewtype=altview&id=INV2-ZG2H-HKAW-PMWU-N6ZR"
// },
// "paid_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "refunded_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// "method": "GET"
// },
// {
// "rel": "update",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
// "method": "PUT"
// },
// {
// "rel": "cancel",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/remind",
// "method": "POST"
// },
// {
// "rel": "remind",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/cancel",
// "method": "POST"
// },
// {
// "rel": "record-payment",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/record-payment",
// "method": "POST"
// },
// {
// "rel": "qr-code",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/qr-code",
// "method": "GET"
// }
// ]
// }
// ],
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices?page=0&page_size=20&total_count_required=true",
// "method": "GET"
// }
// ]
// }
//
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkStringBuilderW_Dispose(sbJsonResponse);
CkJsonObjectW_Dispose(json);
}