C

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded.

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

C

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

void ChilkatSample(void)
    {
    BOOL success;
    HCkJsonObject jsonToken;
    HCkStringBuilder sbAuth;
    HCkRest rest;
    BOOL bAutoReconnect;
    HCkJsonObject json;
    HCkDateTime dtNow;
    HCkStringBuilder sbDt;
    int numReplaced;
    HCkStringBuilder sbPath;
    int numReplacements;
    HCkStringBuilder sbRequestBody;
    HCkStringBuilder 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 = 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);
    dtNow = CkDateTime_Create();
    CkDateTime_SetFromCurrentSystemTime(dtNow);
    sbDt = CkStringBuilder_Create();
    CkStringBuilder_Append(sbDt,CkDateTime_getAsTimestamp(dtNow,FALSE));
    numReplaced = CkStringBuilder_Replace(sbDt,"T"," ");
    numReplaced = CkStringBuilder_Replace(sbDt,"Z"," UTC");
    CkJsonObject_UpdateString(json,"date",CkStringBuilder_getAsString(sbDt));
    CkJsonObject_UpdateString(json,"note","Refunded by credit card!");
    CkJsonObject_UpdateString(json,"amount.currency","USD");
    CkJsonObject_UpdateString(json,"amount.value","500.00");
    printf("%s\n",CkJsonObject_emit(json));

    // The JSON created by the above code:

    // 	{ 
    // 	  "date": "2016-11-28 21:05:38 UTC",
    // 	  "note": "Refunded by credit card!",
    // 	  "amount": { 
    // 	    "currency": "USD",
    // 	    "value": "500.00"
    // 	  }
    // 	}

    // Build a path using a previously-sent invoice ID.
    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/v1/invoicing/invoices/invoice_id/record-refund");
    numReplacements = CkStringBuilder_Replace(sbPath,"invoice_id","INV2-QCHR-QHSD-M2VU-AVXC");

    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);
        CkDateTime_Dispose(dtNow);
        CkStringBuilder_Dispose(sbDt);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

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

    // Check for a success response.
    if (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);
        CkDateTime_Dispose(dtNow);
        CkStringBuilder_Dispose(sbDt);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    // For a success response, the response body is empty.
    printf("Success.\n");


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

    }