C

PayPal - Refund Sale

See more PayPal Examples

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

C

#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 jsonPartial;
    HCkStringBuilder sbPath;
    int numReplaced;
    HCkStringBuilder sbJsonRequest;
    HCkStringBuilder sbJsonResponse;
    BOOL bFullRefund;
    HCkJsonObject json;

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

    // To refund a particular amount, build JSON such as this:
    jsonPartial = CkJsonObject_Create();
    CkJsonObject_putEmitCompact(jsonPartial,FALSE);
    CkJsonObject_UpdateString(jsonPartial,"amount.total","2.34");
    CkJsonObject_UpdateString(jsonPartial,"amount.currency","USD");
    // invoice_number is optional..
    CkJsonObject_UpdateString(jsonPartial,"invoice_number","INV-1234567");
    printf("%s\n",CkJsonObject_emit(jsonPartial));

    // The JSON for a partial refund:

    // 	{ 
    // 	  "amount": { 
    // 	    "total": "2.34",
    // 	    "currency": "USD"
    // 	  },
    // 	  "invoice_number": "INV-1234567"
    // 	}

    CkRest_AddHeader(rest,"Authorization",CkStringBuilder_getAsString(sbAuth));
    CkRest_AddHeader(rest,"Content-Type","application/json");

    // The sale ID is added to the path.
    // The sale ID is obtained from payment records as shown here: Find Completed Sales
    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/v1/payments/sale/sale_id/refund");
    numReplaced = CkStringBuilder_Replace(sbPath,"sale_id","1XC17935MN507400J");

    // Send the POST request containign the JSON in the request body, and get the JSON response.
    sbJsonRequest = CkStringBuilder_Create();
    CkJsonObject_putEmitCompact(jsonPartial,TRUE);
    CkJsonObject_EmitSb(jsonPartial,sbJsonRequest);
    sbJsonResponse = CkStringBuilder_Create();

    bFullRefund = TRUE;
    // To send a full refund, send an empty request body:
    if (bFullRefund == TRUE) {
        CkStringBuilder_Clear(sbJsonRequest);
        CkStringBuilder_Append(sbJsonRequest,"{}");
    }

    success = CkRest_FullRequestSb(rest,"POST",CkStringBuilder_getAsString(sbPath),sbJsonRequest,sbJsonResponse);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkJsonObject_Dispose(jsonToken);
        CkStringBuilder_Dispose(sbAuth);
        CkRest_Dispose(rest);
        CkJsonObject_Dispose(jsonPartial);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbJsonRequest);
        CkStringBuilder_Dispose(sbJsonResponse);
        return;
    }

    json = CkJsonObject_Create();
    CkJsonObject_putEmitCompact(json,FALSE);
    CkJsonObject_LoadSb(json,sbJsonResponse);

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

    // Did we get a 201 success response?
    if (CkRest_getResponseStatusCode(rest) != 201) {
        printf("%s\n",CkJsonObject_emit(json));
        printf("Failed.\n");
        CkJsonObject_Dispose(jsonToken);
        CkStringBuilder_Dispose(sbAuth);
        CkRest_Dispose(rest);
        CkJsonObject_Dispose(jsonPartial);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbJsonRequest);
        CkStringBuilder_Dispose(sbJsonResponse);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("%s\n",CkJsonObject_emit(json));
    printf("Success.\n");

    // A successful JSON response:
    // The "id" is the refund_id.

    // 	{ 
    // 	  "id": "7NE550583A133505U",
    // 	  "create_time": "2016-11-26T16:38:27Z",
    // 	  "update_time": "2016-11-26T16:38:27Z",
    // 	  "state": "completed",
    // 	  "amount": { 
    // 	    "total": "289.00",
    // 	    "currency": "USD"
    // 	  },
    // 	  "sale_id": "1XC17935MN507400J",
    // 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
    // 	  "links": [
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
    // 	      "rel": "self",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
    // 	      "rel": "parent_payment",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
    // 	      "rel": "sale",
    // 	      "method": "GET"
    // 	    }
    // 	  ]
    // 	}


    CkJsonObject_Dispose(jsonToken);
    CkStringBuilder_Dispose(sbAuth);
    CkRest_Dispose(rest);
    CkJsonObject_Dispose(jsonPartial);
    CkStringBuilder_Dispose(sbPath);
    CkStringBuilder_Dispose(sbJsonRequest);
    CkStringBuilder_Dispose(sbJsonResponse);
    CkJsonObject_Dispose(json);

    }