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

Objective-C

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

BOOL success = NO;

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

// To refund a particular amount, build JSON such as this:
CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
[json UpdateString: @"amount.total" value: @"4.54"];
[json UpdateString: @"amount.currency" value: @"USD"];
[json UpdateString: @"description" value: @"Athletic socks"];
[json UpdateString: @"reason" value: @"Refunding because color was incorrect"];
NSLog(@"%@",[json Emit]);

// The JSON:

// 	{ 
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "description": "Athletic socks",
// 	  "reason": "Refunding because color was incorrect"
// 	}
// 
[rest AddHeader: @"Authorization" value: [sbAuth GetAsString]];
[rest AddHeader: @"Content-Type" value: @"application/json"];

// The capture ID is added to the path.
// To list your captures: Find Captures. 
CkoStringBuilder *sbPath = [[CkoStringBuilder alloc] init];
[sbPath Append: @"/v1/payments/capture/capture_id/refund"];
int numReplaced = [[sbPath Replace: @"capture_id" replacement: @"1LY5310469661362J"] intValue];

// Send the POST request containign the JSON in the request body, and get the JSON response.
CkoStringBuilder *sbJsonRequest = [[CkoStringBuilder alloc] init];
json.EmitCompact = YES;
[json EmitSb: sbJsonRequest];
CkoStringBuilder *sbJsonResponse = [[CkoStringBuilder alloc] init];

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

json.EmitCompact = NO;
[json LoadSb: sbJsonResponse];

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

// Did we get a 201 success response?
if ([rest.ResponseStatusCode intValue] != 201) {
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed.");
    return;
}

NSLog(@"%@",[json Emit]);
NSLog(@"%@",@"Success.");

// 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"
// 	    }
// 	  ]
// 	}