1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
class Express_checkout extends CI_Controller
{
function __construct()
{
parent::__construct();
// Load helpers
$this->load->helper('url');
// Load session library
$this->load->library('session');
// Load PayPal library config
$this->config->load('paypal');
$config = array(
'Sandbox' => $this->config->item('Sandbox'), // Sandbox / testing mode option.
'APIUsername' => $this->config->item('APIUsername'), // PayPal API username of the API caller
'APIPassword' => $this->config->item('APIPassword'), // PayPal API password of the API caller
'APISignature' => $this->config->item('APISignature'), // PayPal API signature of the API caller
'APISubject' => '', // PayPal API subject (email address of 3rd party user that has granted API permission for your app)
'APIVersion' => $this->config->item('APIVersion'), // API version you'd like to use for your call. You can set a default version in the class and leave this blank if you want.
'DeviceID' => $this->config->item('DeviceID'),
'ApplicationID' => $this->config->item('ApplicationID'),
'DeveloperEmailAccount' => $this->config->item('DeveloperEmailAccount')
);
// Show Errors
if ($config['Sandbox']) {
error_reporting(E_ALL);
ini_set('display_errors', '1');
}
// Load PayPal library
$this->load->library('paypal/paypal_pro', $config);
}
/**
* Cart Review page
*/
function index()
{
// Clear PayPalResult from session userdata
$this->session->unset_userdata('PayPalResult');
// Clear cart from session userdata
$this->session->unset_userdata('shopping_cart');
// For demo purpose, we create example shopping cart data for display on sample cart review pages
$cart['order_items'] = array(
array(
'name' => 'Demo',
'desc' => 'This is demo product',
'amt' => '9.99',
'qty' => 1,
'taxamt' => 1.99,
)
);
// Example Data - cart item
$cart['items'][0] = array(
'id' => '123-ABC',
'name' => 'Widget',
'qty' => '2',
'price' => '9.99',
);
// Example Data - cart item
$cart['items'][1] = array(
'id' => 'XYZ-456',
'name' => 'Gadget',
'qty' => '1',
'price' => '4.99',
);
// Example Data - cart variable with items included
$cart['shopping_cart'] = array(
'items' => $cart['items'],
'subtotal' => 24.97,
'shipping' => 0,
'handling' => 0,
'tax' => 0,
);
// Example Data - grand total
$cart['shopping_cart']['grand_total'] = number_format($cart['shopping_cart']['subtotal'] + $cart['shopping_cart']['shipping'] + $cart['shopping_cart']['handling'] + $cart['shopping_cart']['tax'], 2);
// Load example cart data to variable
$this->load->vars('cart', $cart);
// Set example cart data into session
$this->session->set_userdata('shopping_cart', $cart);
// Example - Load Review Page
$this->load->view('paypal/demos/express_checkout/index', $cart);
}
/**
* SetExpressCheckout
*/
function SetExpressCheckout()
{
// Clear PayPalResult from session userdata
$this->session->unset_userdata('PayPalResult');
// Get cart data from session userdata
$cart = $this->session->userdata('shopping_cart');
/**
* Here we are setting up the parameters for a basic Express Checkout flow.
*
* The template provided at /vendor/angelleye/paypal-php-library/templates/SetExpressCheckout.php
* contains a lot more parameters that we aren't using here, so I've removed them to keep this clean.
*
* $domain used here is set in the config file.
*/
$SECFields = array(
'maxamt' => round($cart['shopping_cart']['grand_total'] * 2,2), // The expected maximum total amount the order will be, including S&H and sales tax.
'returnurl' => front_url('paypal/demos/express_checkout/GetExpressCheckoutDetails'), // Required. URL to which the customer will be returned after returning from PayPal. 2048 char max.
'cancelurl' => front_url('paypal/demos/express_checkout/OrderCancelled'), // Required. URL to which the customer will be returned if they cancel payment on PayPal's site.
'hdrimg' => 'https://dummyimage.com/750x90/000/fff', // URL for the image displayed as the header during checkout. Max size of 750x90. Should be stored on an https:// server or you'll get a warning message in the browser.
'logoimg' => 'https://dummyimage.com/190x60/000/fff', // A URL to your logo image. Formats: .gif, .jpg, .png. 190x60. PayPal places your logo image at the top of the cart review area. This logo needs to be stored on a https:// server.
'brandname' => 'PayPal Demo', // A label that overrides the business name in the PayPal account on the PayPal hosted checkout pages. 127 char max.
'customerservicenumber' => '852-12345678', // Merchant Customer Service number displayed on the PayPal Review page. 16 char max.
);
/**
* Now we begin setting up our payment(s).
*
* Express Checkout includes the ability to setup parallel payments,
* so we have to populate our $Payments array here accordingly.
*
* For this sample (and in most use cases) we only need a single payment,
* but we still have to populate $Payments with a single $Payment array.
*
* Once again, the template file includes a lot more available parameters,
* but for this basic sample we've removed everything that we're not using,
* so all we have is an amount.
*/
$Payments = array();
$Payment = array(
'amt' => $cart['shopping_cart']['grand_total'], // Required. The total cost of the transaction to the customer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order.
'currencycode' => 'HKD',
);
/**
* Here we push our single $Payment into our $Payments array.
*/
array_push($Payments, $Payment);
/**
* Now we gather all of the arrays above into a single array.
*/
$PayPalRequestData = array(
'SECFields' => $SECFields,
'Payments' => $Payments,
);
/**
* Here we are making the call to the SetExpressCheckout function in the library,
* and we're passing in our $PayPalRequestData that we just set above.
*/
$PayPalResult = $this->paypal_pro->SetExpressCheckout($PayPalRequestData);
/**
* Now we'll check for any errors returned by PayPal, and if we get an error,
* we'll save the error details to a session and redirect the user to an
* error page to display it accordingly.
*
* If all goes well, we save our token in a session variable so that it's
* readily available for us later, and then redirect the user to PayPal
* using the REDIRECTURL returned by the SetExpressCheckout() function.
*/
if(!$this->paypal_pro->APICallSuccessful($PayPalResult['ACK']))
{
$errors = array('Errors'=>$PayPalResult['ERRORS']);
// Load errors to variable
$this->load->vars('errors', $errors);
$this->load->view('paypal/demos/express_checkout/paypal_error');
}
else
{
// Successful call.
// Set PayPalResult into session userdata (so we can grab data from it later on a 'payment complete' page)
$this->session->set_userdata('PayPalResult', $PayPalResult);
// In most cases you would automatically redirect to the returned 'RedirectURL' by using: redirect($PayPalResult['REDIRECTURL'],'Location');
// Move to PayPal checkout
redirect($PayPalResult['REDIRECTURL'], 'Location');
}
}
/**
* GetExpressCheckoutDetails
*/
function GetExpressCheckoutDetails()
{
// Get cart data from session userdata
$cart = $this->session->userdata('shopping_cart');
// Get PayPal data from session userdata
$SetExpressCheckoutPayPalResult = $this->session->userdata('PayPalResult');
$PayPal_Token = $SetExpressCheckoutPayPalResult['TOKEN'];
/**
* Now we pass the PayPal token that we saved to a session variable
* in the SetExpressCheckout.php file into the GetExpressCheckoutDetails
* request.
*/
$PayPalResult = $this->paypal_pro->GetExpressCheckoutDetails($PayPal_Token);
/**
* Now we'll check for any errors returned by PayPal, and if we get an error,
* we'll save the error details to a session and redirect the user to an
* error page to display it accordingly.
*
* If the call is successful, we'll save some data we might want to use
* later into session variables.
*/
if(!$this->paypal_pro->APICallSuccessful($PayPalResult['ACK']))
{
$errors = array('Errors'=>$PayPalResult['ERRORS']);
// Load errors to variable
$this->load->vars('errors', $errors);
$this->load->view('paypal/demos/express_checkout/paypal_error');
}
else
{
// Successful call.
/**
* Here we'll pull out data from the PayPal response.
* Refer to the PayPal API Reference for all of the variables available
* in $PayPalResult['variablename']
*
* https://developer.paypal.com/docs/classic/api/merchant/GetExpressCheckoutDetails_API_Operation_NVP/
*
* Again, Express Checkout allows for parallel payments, so what we're doing here
* is usually the library to parse out the individual payments using the GetPayments()
* method so that we can easily access the data.
*
* We only have a single payment here, which will be the case with most checkouts,
* but we will still loop through the $Payments array returned by the library
* to grab our data accordingly.
*/
$cart['paypal_payer_id'] = isset($PayPalResult['PAYERID']) ? $PayPalResult['PAYERID'] : '';
$cart['phone_number'] = isset($PayPalResult['PHONENUM']) ? $PayPalResult['PHONENUM'] : '';
$cart['email'] = isset($PayPalResult['EMAIL']) ? $PayPalResult['EMAIL'] : '';
$cart['first_name'] = isset($PayPalResult['FIRSTNAME']) ? $PayPalResult['FIRSTNAME'] : '';
$cart['last_name'] = isset($PayPalResult['LASTNAME']) ? $PayPalResult['LASTNAME'] : '';
foreach($PayPalResult['PAYMENTS'] as $payment) {
$cart['shipping_name'] = isset($payment['SHIPTONAME']) ? $payment['SHIPTONAME'] : '';
$cart['shipping_street'] = isset($payment['SHIPTOSTREET']) ? $payment['SHIPTOSTREET'] : '';
$cart['shipping_city'] = isset($payment['SHIPTOCITY']) ? $payment['SHIPTOCITY'] : '';
$cart['shipping_state'] = isset($payment['SHIPTOSTATE']) ? $payment['SHIPTOSTATE'] : '';
$cart['shipping_zip'] = isset($payment['SHIPTOZIP']) ? $payment['SHIPTOZIP'] : '';
$cart['shipping_country_code'] = isset($payment['SHIPTOCOUNTRYCODE']) ? $payment['SHIPTOCOUNTRYCODE'] : '';
$cart['shipping_country_name'] = isset($payment['SHIPTOCOUNTRYNAME']) ? $payment['SHIPTOCOUNTRYNAME'] : '';
}
/**
* At this point, we now have the buyer's shipping address available in our app.
* We could now run the data through a shipping calculator to retrieve rate
* information for this particular order.
*
* This would also be the time to calculate any sales tax you may need to
* add to the order, as well as handling fees.
*
* We're going to set static values for these things in our static
* shopping cart, and then re-calculate our grand total.
*/
$cart['shopping_cart']['shipping'] = 10.00;
$cart['shopping_cart']['handling'] = 2.50;
$cart['shopping_cart']['tax'] = 1.50;
$cart['shopping_cart']['grand_total'] = number_format(
$cart['shopping_cart']['subtotal']
+ $cart['shopping_cart']['shipping']
+ $cart['shopping_cart']['handling']
+ $cart['shopping_cart']['tax'],2);
/**
* Now we will redirect the user to a final review
* page so they can see the shipping/handling/tax
* that has been added to the order.
*/
// Set example cart data into session
$this->session->set_userdata('shopping_cart', $cart);
// Load example cart data to variable
$this->load->vars('cart', $cart);
// Example - Load Review Page
$this->load->view('paypal/demos/express_checkout/review', $cart);
}
}
/**
* DoExpressCheckoutPayment
*/
function DoExpressCheckoutPayment()
{
/**
* Now we'll setup the request params for the final call in the Express Checkout flow.
* This is very similar to SetExpressCheckout except that now we can include values
* for the shipping, handling, and tax amounts, as well as the buyer's name and
* shipping address that we obtained in the GetExpressCheckoutDetails step.
*
* If this information is not included in this final call, it will not be
* available in PayPal's transaction details data.
*
* Once again, the template for DoExpressCheckoutPayment provides
* many more params that are available, but we've stripped everything
* we are not using in this basic demo out.
*/
// Get cart data from session userdata
$cart = $this->session->userdata('shopping_cart');
// Get cart data from session userdata
$SetExpressCheckoutPayPalResult = $this->session->userdata('PayPalResult');
$PayPal_Token = $SetExpressCheckoutPayPalResult['TOKEN'];
$DECPFields = array(
'token' => $PayPal_Token, // Required. A timestamped token, the value of which was returned by a previous SetExpressCheckout call.
'payerid' => $cart['paypal_payer_id'], // Required. Unique PayPal customer id of the payer. Returned by GetExpressCheckoutDetails, or if you used SKIPDETAILS it's returned in the URL back to your RETURNURL.
);
/**
* Just like with SetExpressCheckout, we need to gather our $Payment
* data to pass into our $Payments array. This time we can include
* the shipping, handling, tax, and shipping address details that we
* now have.
*/
$Payments = array();
$Payment = array(
'amt' => number_format($cart['shopping_cart']['grand_total'],2), // Required. The total cost of the transaction to the customer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order.
'itemamt' => number_format($cart['shopping_cart']['subtotal'],2), // Subtotal of items only.
'currencycode' => 'HKD', // A three-character currency code. Default is HKD.
'shippingamt' => number_format($cart['shopping_cart']['shipping'],2), // Total shipping costs for this order. If you specify SHIPPINGAMT you mut also specify a value for ITEMAMT.
'handlingamt' => number_format($cart['shopping_cart']['handling'],2), // Total handling costs for this order. If you specify HANDLINGAMT you mut also specify a value for ITEMAMT.
'taxamt' => number_format($cart['shopping_cart']['tax'],2), // Required if you specify itemized L_TAXAMT fields. Sum of all tax items in this order.
'shiptoname' => $cart['shipping_name'], // Required if shipping is included. Person's name associated with this address. 32 char max.
'shiptostreet' => $cart['shipping_street'], // Required if shipping is included. First street address. 100 char max.
'shiptocity' => $cart['shipping_city'], // Required if shipping is included. Name of city. 40 char max.
'shiptostate' => $cart['shipping_state'], // Required if shipping is included. Name of state or province. 40 char max.
'shiptozip' => $cart['shipping_zip'], // Required if shipping is included. Postal code of shipping address. 20 char max.
'shiptocountrycode' => $cart['shipping_country_code'], // Required if shipping is included. Country code of shipping address. 2 char max.
'shiptophonenum' => $cart['phone_number'], // Phone number for shipping address. 20 char max.
'paymentaction' => 'Sale', // How you want to obtain the payment. When implementing parallel payments, this field is required and must be set to Order.
);
/**
* Here we push our single $Payment into our $Payments array.
*/
array_push($Payments, $Payment);
/**
* Now we gather all of the arrays above into a single array.
*/
$PayPalRequestData = array(
'DECPFields' => $DECPFields,
'Payments' => $Payments,
);
/**
* Here we are making the call to the DoExpressCheckoutPayment function in the library,
* and we're passing in our $PayPalRequestData that we just set above.
*/
$PayPalResult = $this->paypal_pro->DoExpressCheckoutPayment($PayPalRequestData);
/**
* Now we'll check for any errors returned by PayPal, and if we get an error,
* we'll save the error details to a session and redirect the user to an
* error page to display it accordingly.
*
* If the call is successful, we'll save some data we might want to use
* later into session variables, and then redirect to our final
* thank you / receipt page.
*/
if(!$this->paypal_pro->APICallSuccessful($PayPalResult['ACK']))
{
$errors = array('Errors'=>$PayPalResult['ERRORS']);
// Load errors to variable
$this->load->vars('errors', $errors);
$this->load->view('paypal/demos/express_checkout/paypal_error');
}
else
{
// Successful call.
/**
* Once again, since Express Checkout allows for multiple payments in a single transaction,
* the DoExpressCheckoutPayment response is setup to provide data for each potential payment.
* As such, we need to loop through all the payment info in the response.
*
* The library helps us do this using the GetExpressCheckoutPaymentInfo() method. We'll
* load our $payments_info using that method, and then loop through the results to pull
* out our details for the transaction.
*
* Again, in this case we are you only working with a single payment, but we'll still
* loop through the results accordingly.
*
* Here, we're only pulling out the PayPal transaction ID and fee amount, but you may
* refer to the API reference for all the additional parameters you have available at
* this point.
*
* https://developer.paypal.com/docs/classic/api/merchant/DoExpressCheckoutPayment_API_Operation_NVP/
*/
foreach($PayPalResult['PAYMENTS'] as $payment)
{
$cart['paypal_transaction_id'] = isset($payment['TRANSACTIONID']) ? $payment['TRANSACTIONID'] : '';
$cart['paypal_fee'] = isset($payment['FEEAMT']) ? $payment['FEEAMT'] : '';
}
// Set example cart data into session
$this->session->set_userdata('shopping_cart', $cart);
// Successful Order
redirect('paypal/demos/express_checkout/OrderComplete');
}
}
/**
* Order Complete - Pay Return Url
*/
function OrderComplete()
{
// Get cart from session userdata
$cart = $this->session->userdata('shopping_cart');
if(empty($cart)) redirect('paypal/demos/express_checkout');
// Set cart data into session userdata
$this->load->vars('cart', $cart);
// Successful call. Load view or whatever you need to do here.
$this->load->view('paypal/demos/express_checkout/payment_complete');
}
/**
* Order Cancelled - Pay Cancel Url
*/
function OrderCancelled()
{
// Clear PayPalResult from session userdata
$this->session->unset_userdata('PayPalResult');
// Clear cart from session userdata
$this->session->unset_userdata('shopping_cart');
// Successful call. Load view or whatever you need to do here.
$this->load->view('paypal/demos/express_checkout/order_cancelled');
}
}
|