Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

C Web API Examples

Primary Categories

AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Jira
MYOB

Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
Xero
eBay
effectconnect

 

 

 

(C) PayPal - Cancel Sent Invoice

Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and Cc: emails.

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat C/C++ Library Downloads

MS Visual C/C++

Linux/CentOS C/C++

Alpine Linux C/C++

MAC OS X C/C++

armhf/aarch64 C/C++

C++ Builder

iOS C/C++

Android C/C++

Win Mobile 5.0/Pocket PC 2003

Solaris C/C++

FreeBSD C/C++

OpenBSD C/C++

MinGW C/C++

#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkRest.h>

void ChilkatSample(void)
    {
    HCkJsonObject jsonToken;
    HCkStringBuilder sbAuth;
    HCkRest rest;
    BOOL bAutoReconnect;
    BOOL success;
    HCkJsonObject json;
    HCkStringBuilder sbPath;
    int numReplacements;
    HCkStringBuilder sbRequestBody;
    HCkStringBuilder sbResponseBody;

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

    // Build the JSON request body containing the reminder information:
    json = CkJsonObject_Create();
    CkJsonObject_putEmitCompact(json,FALSE);
    CkJsonObject_UpdateString(json,"subject","Past due");
    CkJsonObject_UpdateString(json,"note","Canceling invoice");
    CkJsonObject_UpdateBool(json,"send_to_merchant",TRUE);
    CkJsonObject_UpdateBool(json,"send_to_payer",TRUE);
    printf("%s\n",CkJsonObject_emit(json));

    // The JSON created by the above code:

    // 	{ 
    // 	  "subject": "Past due",
    // 	  "note": "Canceling invoice",
    // 	  "send_to_merchant": true,
    // 	  "send_to_payer": true
    // 	}

    // Build a path using a previously-sent invoice ID.
    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/v1/invoicing/invoices/invoice_id/cancel");
    numReplacements = CkStringBuilder_Replace(sbPath,"invoice_id","INV2-XPWZ-NUTQ-LNWB-P8NC");

    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",CkStringBuilder_getAsString(sbPath),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(sbPath);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    printf("Response Status Code = %d\n",CkRest_getResponseStatusCode(rest));

    // In our testing, we received a 204 response, which is a success HTTP response code, but 
    // differs from the PayPal REST API reference documentation, which states that a 202 response
    // is expected.  I suspect an error in the PayPal documentation, or in the PayPal responder.
    // Check for either 202 or 204..
    // Did we get a 202 accepted response?
    if ((CkRest_getResponseStatusCode(rest) != 202) && (CkRest_getResponseStatusCode(rest) != 204)) {
        printf("%s\n",CkStringBuilder_getAsString(sbResponseBody));
        printf("Failed.\n");
        CkJsonObject_Dispose(jsonToken);
        CkStringBuilder_Dispose(sbAuth);
        CkRest_Dispose(rest);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    // The 202/204 response should be empty.  (Again, our experience differs from the online PayPal documentation..)
    printf("Success.\n");


    CkJsonObject_Dispose(jsonToken);
    CkStringBuilder_Dispose(sbAuth);
    CkRest_Dispose(rest);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbPath);
    CkStringBuilder_Dispose(sbRequestBody);
    CkStringBuilder_Dispose(sbResponseBody);

    }

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.