C
C
PayPal Search for Invoices
See more PayPal Examples
Search PayPal invoices.See also SearchInvoices
Chilkat C Downloads
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkRest.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObject jsonToken;
HCkStringBuilder sbAuth;
HCkRest rest;
BOOL bAutoReconnect;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkStringBuilder sbResponseBody;
HCkJsonObject jsonResponse;
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 = CkJsonObject_Create();
CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/paypal.json");
// Build the Authorization request header field value.
sbAuth = CkStringBuilder_Create();
// token_type should be "Bearer"
CkStringBuilder_Append(sbAuth,CkJsonObject_stringOf(jsonToken,"token_type"));
CkStringBuilder_Append(sbAuth," ");
CkStringBuilder_Append(sbAuth,CkJsonObject_stringOf(jsonToken,"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 = CkRest_Create();
bAutoReconnect = TRUE;
success = CkRest_Connect(rest,"api.sandbox.paypal.com",443,TRUE,bAutoReconnect);
if (success != TRUE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_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..
// ----------------------------------------------------------------------------------------------
// Create JSON to specify the search
json = CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,FALSE);
CkJsonObject_AppendString(json,"start_invoice_date","2016-01-01 PST");
CkJsonObject_AppendString(json,"end_invoice_date","2016-11-16 PST");
CkJsonObject_AppendInt(json,"page",0);
CkJsonObject_AppendInt(json,"page_size",10);
CkJsonObject_AppendBool(json,"total_count_required",TRUE);
printf("%s\n",CkJsonObject_emit(json));
// The JSON by the above code:
// {
// "start_invoice_date": "2016-01-01 PST",
// "end_invoice_date": "2016-11-16 PST",
// "page": 0,
// "page_size": 10,
// "total_count_required": true
// }
// Send the POST equivalent to this CURL command:
// curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/search/ \
// -H "Content-Type:application/json" \
// -H "Authorization: Bearer Access-Token" \
// -d '{ invoice JSON goes here }'
CkJsonObject_putEmitCompact(json,TRUE);
sbRequestBody = CkStringBuilder_Create();
sbResponseBody = CkStringBuilder_Create();
CkRest_AddHeader(rest,"Content-Type","application/json");
CkRest_AddHeader(rest,"Authorization",CkStringBuilder_getAsString(sbAuth));
CkJsonObject_EmitSb(json,sbRequestBody);
success = CkRest_FullRequestSb(rest,"POST","/v1/invoicing/search",sbRequestBody,sbResponseBody);
if (success != TRUE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
// We should have some sort of JSON response. It could be successful, or an error.
jsonResponse = CkJsonObject_Create();
CkJsonObject_putEmitCompact(jsonResponse,FALSE);
CkJsonObject_LoadSb(jsonResponse,sbResponseBody);
printf("Response Status Code = %d\n",CkRest_getResponseStatusCode(rest));
// Did we get a 200 success response?
if (CkRest_getResponseStatusCode(rest) != 200) {
// Show the JSON response body
printf("%s\n",CkJsonObject_emit(jsonResponse));
printf("Failed.\n");
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jsonResponse);
return;
}
// Sample response JSON is shown below.
// Iterate over each invoice and get some information from each..
numInvoices = CkJsonObject_SizeOfArray(jsonResponse,"invoices");
i = 0;
while (i < numInvoices) {
CkJsonObject_putI(jsonResponse,i);
printf("Invoice ID: %s\n",CkJsonObject_stringOf(jsonResponse,"invoices[i].id"));
printf("Shipping First Name: %s\n",CkJsonObject_stringOf(jsonResponse,"invoices[i].shipping_info.first_name"));
j = 0;
numBillingInfo = CkJsonObject_SizeOfArray(jsonResponse,"invoices[i].billing_info");
while (j < numBillingInfo) {
CkJsonObject_putJ(jsonResponse,j);
printf("billing_info email: %s\n",CkJsonObject_stringOf(jsonResponse,"invoices[i].billing_info[j].email"));
j = j + 1;
}
numLinks = CkJsonObject_SizeOfArray(jsonResponse,"invoices[i].links");
j = 0;
while (j < numLinks) {
CkJsonObject_putJ(jsonResponse,j);
printf("link: %s\n",CkJsonObject_stringOf(jsonResponse,"invoices[i].links[j].href"));
j = j + 1;
}
printf("----\n");
i = i + 1;
}
printf("Success.\n");
// A successful response looks like this:
// {
// "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"
// }
// ]
// }
// ]
// }
//
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jsonResponse);
}