Objective-C

PayPal - Create a PayPal Payment

See more PayPal Examples

Creates a payment to be paid from a PayPal account (as opposed to being funded by a credit card).

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.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 containing the transaction information.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
[json UpdateString: @"intent" value: @"sale"];
[json UpdateString: @"redirect_urls.return_url" value: @"http://www.example.com/return_url"];
[json UpdateString: @"redirect_urls.cancel_url" value: @"http://www.example.com/cancel_url"];
[json UpdateString: @"payer.payment_method" value: @"paypal"];
[json UpdateString: @"transactions[0].amount.total" value: @"7.47"];
[json UpdateString: @"transactions[0].amount.currency" value: @"USD"];
[json UpdateString: @"transactions[0].description" value: @"This is the payment transaction description."];

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

// The JSON created by the above code is this:

// 	{ 
// 	  "intent": "sale",
// 	  "redirect_urls": { 
// 	    "return_url": "http://www.example.com/return_url",
// 	    "cancel_url": "http://www.example.com/cancel_url"
// 	  },
// 	  "payer": { 
// 	    "payment_method": "paypal"
// 	  },
// 	  "transactions": [
// 	    { 
// 	      "amount": { 
// 	        "total": "7.47",
// 	        "currency": "USD"
// 	      },
// 	      "description": "This is the payment transaction description."
// 	    }
// 	  ]
// 	}

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

// 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: @"/v1/payments/payment" 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;
}

// Sample JSON response is shown below.
NSLog(@"%@",[json Emit]);
NSLog(@"%@",@"success");

// ------------------------------------------------
// A sample JSON response:

// 	{ 
// 	  "id": "PAY-1XK50350XV338620BLA3CZGI",
// 	  "intent": "sale",
// 	  "state": "created",
// 	  "payer": { 
// 	    "payment_method": "paypal",
// 	    "use_vendor_currency_conversion": false
// 	  },
// 	  "transactions": [
// 	    { 
// 	      "amount": { 
// 	        "total": "7.47",
// 	        "currency": "USD"
// 	      },
// 	      "description": "This is the payment transaction description.",
// 	      "related_resources": [
// 	      ]
// 	    }
// 	  ],
// 	  "create_time": "2016-11-23T23:56:09Z",
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0BG932459F977083J",
// 	      "rel": "approval_url",
// 	      "method": "REDIRECT"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI/execute",
// 	      "rel": "execute",
// 	      "method": "POST"
// 	    }
// 	  ]
// 	}