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

Objective-C

#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoRest.h>
#import <CkoDateTime.h>

BOOL success = NO;

// 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)
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
[jsonToken LoadFile: @"qa_data/tokens/paypal.json"];

// Build the Authorization request header field value.
CkoStringBuilder *sbAuth = [[CkoStringBuilder alloc] init];
// token_type should be "Bearer"
[sbAuth Append: [jsonToken StringOf: @"token_type"]];
[sbAuth Append: @" "];
[sbAuth Append: [jsonToken StringOf: @"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.
CkoRest *rest = [[CkoRest alloc] init];
BOOL bAutoReconnect = YES;
success = [rest Connect: @"api.sandbox.paypal.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    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:
CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
CkoDateTime *dtNow = [[CkoDateTime alloc] init];
[dtNow SetFromCurrentSystemTime];
CkoStringBuilder *sbDt = [[CkoStringBuilder alloc] init];
[sbDt Append: [dtNow GetAsTimestamp: NO]];
int numReplaced = [[sbDt Replace: @"T" replacement: @" "] intValue];
numReplaced = [[sbDt Replace: @"Z" replacement: @" UTC"] intValue];
[json UpdateString: @"date" value: [sbDt GetAsString]];
[json UpdateString: @"note" value: @"Refunded by credit card!"];
[json UpdateString: @"amount.currency" value: @"USD"];
[json UpdateString: @"amount.value" value: @"500.00"];
NSLog(@"%@",[json Emit]);

// 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.
CkoStringBuilder *sbPath = [[CkoStringBuilder alloc] init];
[sbPath Append: @"/v1/invoicing/invoices/invoice_id/record-refund"];
int numReplacements = [[sbPath Replace: @"invoice_id" replacement: @"INV2-QCHR-QHSD-M2VU-AVXC"] intValue];

json.EmitCompact = YES;
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];

[rest AddHeader: @"Content-Type" value: @"application/json"];
[rest AddHeader: @"Authorization" value: [sbAuth GetAsString]];
[json EmitSb: sbRequestBody];

success = [rest FullRequestSb: @"POST" uriPath: [sbPath GetAsString] requestBody: sbRequestBody responseBody: sbResponseBody];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

NSLog(@"%@%d",@"Response Status Code = ",[rest.ResponseStatusCode intValue]);

// Check for a success response.
if ([rest.ResponseStatusCode intValue] != 204) {
    NSLog(@"%@",[sbResponseBody GetAsString]);
    NSLog(@"%@",@"Failed.");
    return;
}

// For a success response, the response body is empty.
NSLog(@"%@",@"Success.");