Unicode C
Unicode 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.
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 jsonPartial;
HCkStringBuilderW sbPath;
int numReplaced;
HCkStringBuilderW sbJsonRequest;
HCkStringBuilderW sbJsonResponse;
BOOL bFullRefund;
HCkJsonObjectW 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 = 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:
jsonPartial = CkJsonObjectW_Create();
CkJsonObjectW_putEmitCompact(jsonPartial,FALSE);
CkJsonObjectW_UpdateString(jsonPartial,L"amount.total",L"2.34");
CkJsonObjectW_UpdateString(jsonPartial,L"amount.currency",L"USD");
// invoice_number is optional..
CkJsonObjectW_UpdateString(jsonPartial,L"invoice_number",L"INV-1234567");
wprintf(L"%s\n",CkJsonObjectW_emit(jsonPartial));
// The JSON for a partial refund:
// {
// "amount": {
// "total": "2.34",
// "currency": "USD"
// },
// "invoice_number": "INV-1234567"
// }
CkRestW_AddHeader(rest,L"Authorization",CkStringBuilderW_getAsString(sbAuth));
CkRestW_AddHeader(rest,L"Content-Type",L"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 = CkStringBuilderW_Create();
CkStringBuilderW_Append(sbPath,L"/v1/payments/sale/sale_id/refund");
numReplaced = CkStringBuilderW_Replace(sbPath,L"sale_id",L"1XC17935MN507400J");
// Send the POST request containign the JSON in the request body, and get the JSON response.
sbJsonRequest = CkStringBuilderW_Create();
CkJsonObjectW_putEmitCompact(jsonPartial,TRUE);
CkJsonObjectW_EmitSb(jsonPartial,sbJsonRequest);
sbJsonResponse = CkStringBuilderW_Create();
bFullRefund = TRUE;
// To send a full refund, send an empty request body:
if (bFullRefund == TRUE) {
CkStringBuilderW_Clear(sbJsonRequest);
CkStringBuilderW_Append(sbJsonRequest,L"{}");
}
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(jsonPartial);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
return;
}
json = CkJsonObjectW_Create();
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(jsonPartial);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
CkJsonObjectW_Dispose(json);
return;
}
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"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"
// }
// ]
// }
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(jsonPartial);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
CkJsonObjectW_Dispose(json);
}