Unicode C

PayPal - Cancel Sent Invoice

See more PayPal Examples

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.

Unicode C

#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 sbPath;
    int numReplacements;
    HCkStringBuilderW sbRequestBody;
    HCkStringBuilderW sbResponseBody;

    success = FALSE;

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

    // Build the JSON request body containing the reminder information:
    json = CkJsonObjectW_Create();
    CkJsonObjectW_putEmitCompact(json,FALSE);
    CkJsonObjectW_UpdateString(json,L"subject",L"Past due");
    CkJsonObjectW_UpdateString(json,L"note",L"Canceling invoice");
    CkJsonObjectW_UpdateBool(json,L"send_to_merchant",TRUE);
    CkJsonObjectW_UpdateBool(json,L"send_to_payer",TRUE);
    wprintf(L"%s\n",CkJsonObjectW_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 = CkStringBuilderW_Create();
    CkStringBuilderW_Append(sbPath,L"/v1/invoicing/invoices/invoice_id/cancel");
    numReplacements = CkStringBuilderW_Replace(sbPath,L"invoice_id",L"INV2-XPWZ-NUTQ-LNWB-P8NC");

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

    wprintf(L"Response Status Code = %d\n",CkRestW_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 ((CkRestW_getResponseStatusCode(rest) != 202) && (CkRestW_getResponseStatusCode(rest) != 204)) {
        wprintf(L"%s\n",CkStringBuilderW_getAsString(sbResponseBody));
        wprintf(L"Failed.\n");
        CkJsonObjectW_Dispose(jsonToken);
        CkStringBuilderW_Dispose(sbAuth);
        CkRestW_Dispose(rest);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbPath);
        CkStringBuilderW_Dispose(sbRequestBody);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

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


    CkJsonObjectW_Dispose(jsonToken);
    CkStringBuilderW_Dispose(sbAuth);
    CkRestW_Dispose(rest);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbPath);
    CkStringBuilderW_Dispose(sbRequestBody);
    CkStringBuilderW_Dispose(sbResponseBody);

    }