C

PayPal - Refund Captured Payment

See more PayPal Examples

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

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 json;
    HCkStringBuilder sbPath;
    int numReplaced;
    HCkStringBuilder sbJsonRequest;
    HCkStringBuilder sbJsonResponse;

    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:
    json = CkJsonObject_Create();
    CkJsonObject_putEmitCompact(json,FALSE);
    CkJsonObject_UpdateString(json,"amount.total","4.54");
    CkJsonObject_UpdateString(json,"amount.currency","USD");
    CkJsonObject_UpdateString(json,"description","Athletic socks");
    CkJsonObject_UpdateString(json,"reason","Refunding because color was incorrect");
    printf("%s\n",CkJsonObject_emit(json));

    //  The JSON:

    //  	{ 
    //  	  "amount": { 
    //  	    "total": "4.54",
    //  	    "currency": "USD"
    //  	  },
    //  	  "description": "Athletic socks",
    //  	  "reason": "Refunding because color was incorrect"
    //  	}
    //  
    CkRest_AddHeader(rest,"Authorization",CkStringBuilder_getAsString(sbAuth));
    CkRest_AddHeader(rest,"Content-Type","application/json");

    //  The capture ID is added to the path.
    //  To list your captures: Find Captures. 
    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/v1/payments/capture/capture_id/refund");
    numReplaced = CkStringBuilder_Replace(sbPath,"capture_id","1LY5310469661362J");

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

    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(json);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbJsonRequest);
        CkStringBuilder_Dispose(sbJsonResponse);
        return;
    }

    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(json);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbJsonRequest);
        CkStringBuilder_Dispose(sbJsonResponse);
        return;
    }

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

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

    //  	{ 
    //  	  "id": "77B77607RR7243500",
    //  	  "create_time": "2016-11-27T01:38:25Z",
    //  	  "update_time": "2016-11-27T01:38:25Z",
    //  	  "state": "completed",
    //  	  "amount": { 
    //  	    "total": "4.54",
    //  	    "currency": "USD"
    //  	  },
    //  	  "capture_id": "1LY5310469661362J",
    //  	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    //  	  "links": [
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
    //  	      "rel": "self",
    //  	      "method": "GET"
    //  	    },
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
    //  	      "rel": "parent_payment",
    //  	      "method": "GET"
    //  	    },
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
    //  	      "rel": "capture",
    //  	      "method": "GET"
    //  	    }
    //  	  ]
    //  	}


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

    }