Unicode C
Unicode 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.
Chilkat Unicode C Downloads
#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 numReplaced;
HCkStringBuilderW sbJsonRequest;
HCkStringBuilderW 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 = 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..
// ----------------------------------------------------------------------------------------------
// To refund a particular amount, build JSON such as this:
json = CkJsonObjectW_Create();
CkJsonObjectW_putEmitCompact(json,FALSE);
CkJsonObjectW_UpdateString(json,L"amount.total",L"4.54");
CkJsonObjectW_UpdateString(json,L"amount.currency",L"USD");
CkJsonObjectW_UpdateString(json,L"description",L"Athletic socks");
CkJsonObjectW_UpdateString(json,L"reason",L"Refunding because color was incorrect");
wprintf(L"%s\n",CkJsonObjectW_emit(json));
// The JSON:
// {
// "amount": {
// "total": "4.54",
// "currency": "USD"
// },
// "description": "Athletic socks",
// "reason": "Refunding because color was incorrect"
// }
//
CkRestW_AddHeader(rest,L"Authorization",CkStringBuilderW_getAsString(sbAuth));
CkRestW_AddHeader(rest,L"Content-Type",L"application/json");
// The capture ID is added to the path.
// To list your captures: Find Captures.
sbPath = CkStringBuilderW_Create();
CkStringBuilderW_Append(sbPath,L"/v1/payments/capture/capture_id/refund");
numReplaced = CkStringBuilderW_Replace(sbPath,L"capture_id",L"1LY5310469661362J");
// Send the POST request containign the JSON in the request body, and get the JSON response.
sbJsonRequest = CkStringBuilderW_Create();
CkJsonObjectW_putEmitCompact(json,TRUE);
CkJsonObjectW_EmitSb(json,sbJsonRequest);
sbJsonResponse = CkStringBuilderW_Create();
success = CkRestW_FullRequestSb(rest,L"POST",CkStringBuilderW_getAsString(sbPath),sbJsonRequest,sbJsonResponse);
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(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
return;
}
CkJsonObjectW_putEmitCompact(json,FALSE);
CkJsonObjectW_LoadSb(json,sbJsonResponse);
wprintf(L"Response Status Code = %d\n",CkRestW_getResponseStatusCode(rest));
// Did we get a 201 success response?
if (CkRestW_getResponseStatusCode(rest) != 201) {
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"Failed.\n");
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
return;
}
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"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"
// }
// ]
// }
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
}