-
Notifications
You must be signed in to change notification settings - Fork 211
/
Copy pathclass-wc-stripe-intent-controller.php
1262 lines (1090 loc) · 48.9 KB
/
class-wc-stripe-intent-controller.php
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* WC_Stripe_Intent_Controller class.
*
* Handles in-checkout AJAX calls, related to Payment Intents.
*/
class WC_Stripe_Intent_Controller {
/**
* Holds an instance of the gateway class.
*
* @since 4.2.0
* @var WC_Gateway_Stripe
*/
protected $gateway;
/**
* Adds the necessary hooks.
*
* @since 4.2.0
*/
public function init_hooks() {
add_action( 'wc_ajax_wc_stripe_verify_intent', [ $this, 'verify_intent' ] );
add_action( 'wc_ajax_wc_stripe_create_setup_intent', [ $this, 'create_setup_intent' ] );
add_action( 'wc_ajax_wc_stripe_create_and_confirm_setup_intent', [ $this, 'create_and_confirm_setup_intent_ajax' ] );
add_action( 'wc_ajax_wc_stripe_create_payment_intent', [ $this, 'create_payment_intent_ajax' ] );
add_action( 'wc_ajax_wc_stripe_update_payment_intent', [ $this, 'update_payment_intent_ajax' ] );
add_action( 'wc_ajax_wc_stripe_init_setup_intent', [ $this, 'init_setup_intent_ajax' ] );
add_action( 'wc_ajax_wc_stripe_update_order_status', [ $this, 'update_order_status_ajax' ] );
add_action( 'wc_ajax_wc_stripe_update_failed_order', [ $this, 'update_failed_order_ajax' ] );
add_action( 'wc_ajax_wc_stripe_confirm_change_payment', [ $this, 'confirm_change_payment_from_setup_intent_ajax' ] );
}
/**
* Returns an instantiated gateway.
*
* @since 4.2.0
* @return WC_Stripe_Payment_Gateway
*/
protected function get_gateway() {
if ( ! isset( $this->gateway ) ) {
$gateways = WC()->payment_gateways()->payment_gateways();
$this->gateway = $gateways[ WC_Gateway_Stripe::ID ];
}
return $this->gateway;
}
/**
* Returns an instantiated UPE gateway
*
* @since 5.6.0
* @throws WC_Stripe_Exception if UPE is not enabled.
* @return WC_Stripe_UPE_Payment_Gateway
*/
protected function get_upe_gateway() {
$gateway = $this->get_gateway();
if ( ! $gateway instanceof WC_Stripe_UPE_Payment_Gateway ) {
WC_Stripe_Logger::log( 'Error instantiating the UPE Payment Gateway, UPE is not enabled.' );
throw new WC_Stripe_Exception( __( "We're not able to process this payment.", 'woocommerce-gateway-stripe' ) );
}
return $gateway;
}
/**
* Loads the order from the current request.
*
* @since 4.2.0
* @throws WC_Stripe_Exception An exception if there is no order ID or the order does not exist.
* @return WC_Order
*/
protected function get_order_from_request() {
if ( ! isset( $_GET['nonce'] ) || ! wp_verify_nonce( sanitize_key( $_GET['nonce'] ), 'wc_stripe_confirm_pi' ) ) {
throw new WC_Stripe_Exception( 'missing-nonce', __( 'CSRF verification failed.', 'woocommerce-gateway-stripe' ) );
}
// Load the order ID.
$order_id = null;
if ( isset( $_GET['order'] ) && absint( $_GET['order'] ) ) {
$order_id = absint( $_GET['order'] );
}
// Retrieve the order.
$order = wc_get_order( $order_id );
if ( ! $order ) {
throw new WC_Stripe_Exception( 'missing-order', __( 'Missing order ID for payment confirmation', 'woocommerce-gateway-stripe' ) );
}
return $order;
}
/**
* Handles successful PaymentIntent authentications.
*
* @since 4.2.0
*/
public function verify_intent() {
global $woocommerce;
$order = false;
$gateway = $this->get_gateway();
try {
$order = $this->get_order_from_request();
} catch ( WC_Stripe_Exception $e ) {
/* translators: Error message text */
$message = sprintf( __( 'Payment verification error: %s', 'woocommerce-gateway-stripe' ), $e->getLocalizedMessage() );
wc_add_notice( esc_html( $message ), 'error' );
$redirect_url = $woocommerce->cart->is_empty()
? get_permalink( wc_get_page_id( 'shop' ) )
: wc_get_checkout_url();
$this->handle_error( $e, $redirect_url );
}
try {
$gateway->verify_intent_after_checkout( $order );
if ( isset( $_GET['save_payment_method'] ) && ! empty( $_GET['save_payment_method'] ) ) {
$intent = $gateway->get_intent_from_order( $order );
if ( isset( $intent->last_payment_error ) ) {
$last_payment_error = $intent->last_payment_error;
$source_id = '';
// Backwards compatibility for payment intents that use sources.
if ( isset( $last_payment_error->payment_method->id ) ) {
$source_id = $last_payment_error->payment_method->id;
} elseif ( isset( $last_payment_error->source->id ) ) {
$source_id = $last_payment_error->source->id;
}
// Currently, Stripe saves the payment method even if the authentication fails for 3DS cards.
// Although, the card is not stored in DB we need to remove the source from the customer on Stripe
// in order to keep the sources in sync with the data in DB.
if ( ! empty( $source_id ) ) {
$customer = new WC_Stripe_Customer( wp_get_current_user()->ID );
$customer->delete_source( $source_id );
}
} else {
$metadata = $intent->metadata;
if ( isset( $metadata->save_payment_method ) && 'true' === $metadata->save_payment_method ) {
$payment_method = WC_Stripe_Helper::get_payment_method_from_intent( $intent );
$source_object = WC_Stripe_API::get_payment_method(
// The object on the intent may have been expanded so we need to check if it's just the ID or the full object.
is_string( $payment_method ) ? $payment_method : $payment_method->id
);
$gateway->save_payment_method( $source_object );
}
}
}
if ( ! isset( $_GET['is_ajax'] ) ) {
$redirect_url = isset( $_GET['redirect_to'] ) // wpcs: csrf ok.
? esc_url_raw( wp_unslash( $_GET['redirect_to'] ) ) // wpcs: csrf ok.
: $gateway->get_return_url( $order );
wp_safe_redirect( $redirect_url );
}
exit;
} catch ( WC_Stripe_Exception $e ) {
$this->handle_error( $e, $gateway->get_return_url( $order ) );
}
}
/**
* Handles exceptions during intent verification.
*
* @since 4.2.0
* @param WC_Stripe_Exception $e The exception that was thrown.
* @param string $redirect_url An URL to use if a redirect is needed.
*/
protected function handle_error( $e, $redirect_url ) {
// Log the exception before redirecting.
$message = sprintf( 'PaymentIntent verification exception: %s', $e->getLocalizedMessage() );
WC_Stripe_Logger::log( $message );
// `is_ajax` is only used for PI error reporting, a response is not expected.
if ( isset( $_GET['is_ajax'] ) ) {
exit;
}
wp_safe_redirect( $redirect_url );
exit;
}
/**
* Creates a Setup Intent through AJAX while adding cards.
*/
public function create_setup_intent() {
if (
! is_user_logged_in()
|| ! isset( $_POST['stripe_source_id'] )
|| ! isset( $_POST['nonce'] )
) {
return;
}
// similar rate limiter is present in WC Core, but it's executed on page submission (and not on AJAX calls).
$wc_add_payment_method_rate_limit_id = 'add_payment_method_' . get_current_user_id();
if ( WC_Rate_Limiter::retried_too_soon( $wc_add_payment_method_rate_limit_id ) ) {
echo wp_json_encode(
[
'status' => 'error',
'error' => [
'type' => 'setup_intent_error',
'message' => __( 'Failed to save payment method.', 'woocommerce-gateway-stripe' ),
],
]
);
exit;
}
try {
$source_id = wc_clean( wp_unslash( $_POST['stripe_source_id'] ) );
// 1. Verify.
if (
! wp_verify_nonce( sanitize_key( $_POST['nonce'] ), 'wc_stripe_create_si' )
|| ! ( 0 === strpos( $source_id, 'src_' ) || 0 === strpos( $source_id, 'pm_' ) )
) {
throw new Exception( __( 'Unable to verify your request. Please reload the page and try again.', 'woocommerce-gateway-stripe' ) );
}
// 2. Load the customer ID (and create a customer eventually).
$customer = new WC_Stripe_Customer( wp_get_current_user()->ID );
$customer->maybe_create_customer();
// 3. Fetch the source object.
$source_object = WC_Stripe_API::get_payment_method( $source_id );
if ( ! empty( $source_object->error ) ) {
throw new Exception( $source_object->error->message );
}
if ( is_wp_error( $source_object ) ) {
throw new Exception( $source_object->get_error_message() );
}
// SEPA Direct Debit payments do not require any customer action after the source has been created.
// Once the customer has provided their IBAN details and accepted the mandate, no further action is needed and the resulting source is directly chargeable.
if ( WC_Stripe_Payment_Methods::SEPA_DEBIT === $source_object->type ) {
$response = [
'status' => 'success',
];
echo wp_json_encode( $response );
return;
}
// 4. Generate the setup intent
$setup_intent = WC_Stripe_API::request(
[
'customer' => $customer->get_id(),
'confirm' => 'true',
'payment_method' => $source_id,
'payment_method_types' => [ $source_object->type ],
],
'setup_intents'
);
if ( ! empty( $setup_intent->error ) ) {
$error_response_message = print_r( $setup_intent, true );
WC_Stripe_Logger::log( 'Failed create Setup Intent while saving a card.' );
WC_Stripe_Logger::log( "Response: $error_response_message" );
throw new Exception( __( 'Your card could not be set up for future usage.', 'woocommerce-gateway-stripe' ) );
}
// 5. Respond.
if ( WC_Stripe_Intent_Status::REQUIRES_ACTION === $setup_intent->status ) {
$response = [
'status' => WC_Stripe_Intent_Status::REQUIRES_ACTION,
'client_secret' => $setup_intent->client_secret,
];
} elseif ( WC_Stripe_Intent_Status::REQUIRES_PAYMENT_METHOD === $setup_intent->status
|| WC_Stripe_Intent_Status::REQUIRES_CONFIRMATION === $setup_intent->status
|| WC_Stripe_Intent_Status::CANCELED === $setup_intent->status ) {
// These statuses should not be possible, as such we return an error.
$response = [
'status' => 'error',
'error' => [
'type' => 'setup_intent_error',
'message' => __( 'Failed to save payment method.', 'woocommerce-gateway-stripe' ),
],
];
} else {
// This should only be reached when status is `processing` or `succeeded`, which are
// the only statuses that we haven't explicitly handled.
$response = [
'status' => 'success',
];
}
} catch ( Exception $e ) {
$response = [
'status' => 'error',
'error' => [
'type' => 'setup_intent_error',
'message' => $e->getMessage(),
],
];
}
echo wp_json_encode( $response );
exit;
}
/**
* Handle AJAX requests for creating a payment intent for Stripe UPE.
*/
public function create_payment_intent_ajax() {
try {
$is_nonce_valid = check_ajax_referer( 'wc_stripe_create_payment_intent_nonce', false, false );
if ( ! $is_nonce_valid ) {
throw new Exception( __( "We're not able to process this payment. Please refresh the page and try again.", 'woocommerce-gateway-stripe' ) );
}
// If paying from order, we need to get the total from the order instead of the cart.
$order_id = isset( $_POST['stripe_order_id'] ) ? absint( $_POST['stripe_order_id'] ) : null;
$payment_method_type = isset( $_POST['payment_method_type'] ) ? wc_clean( wp_unslash( $_POST['payment_method_type'] ) ) : '';
if ( $order_id ) {
$order = wc_get_order( $order_id );
if ( ! $order || ! $order->needs_payment() ) {
throw new Exception( __( 'Unable to process your request. Please reload the page and try again.', 'woocommerce-gateway-stripe' ) );
}
}
wp_send_json_success( $this->create_payment_intent( $order_id, $payment_method_type ), 200 );
} catch ( Exception $e ) {
WC_Stripe_Logger::log( 'Create payment intent error: ' . $e->getMessage() );
// Send back error so it can be displayed to the customer.
wp_send_json_error(
[
'error' => [
'message' => $e->getMessage(),
],
]
);
}
}
/**
* Creates payment intent using current cart or order and store details.
*
* @param int|null $order_id The id of the order if intent created from Order.
* @param string|null $payment_method_type The type of payment method to use for the intent.
*
* @throws Exception - If the create intent call returns with an error.
* @return array
*/
public function create_payment_intent( $order_id = null, $payment_method_type = null ) {
$amount = WC()->cart->get_total( false );
$order = wc_get_order( $order_id );
if ( is_a( $order, 'WC_Order' ) ) {
$amount = $order->get_total();
}
$gateway = $this->get_upe_gateway();
$enabled_payment_methods = $payment_method_type ? [ $payment_method_type ] : $gateway->get_upe_enabled_at_checkout_payment_method_ids( $order_id );
$currency = get_woocommerce_currency();
$capture = $gateway->is_automatic_capture_enabled();
$request = [
'amount' => WC_Stripe_Helper::get_stripe_amount( $amount, strtolower( $currency ) ),
'currency' => strtolower( $currency ),
'payment_method_types' => $enabled_payment_methods,
'capture_method' => $capture ? 'automatic' : 'manual',
];
$request = $this->maybe_add_mandate_options( $request, $payment_method_type );
$payment_intent = WC_Stripe_API::request( $request, 'payment_intents' );
if ( ! empty( $payment_intent->error ) ) {
throw new Exception( $payment_intent->error->message );
}
return [
'id' => $payment_intent->id,
'client_secret' => $payment_intent->client_secret,
];
}
/**
* Handle AJAX request for updating a payment intent for Stripe UPE.
*
* @since 5.6.0
*/
public function update_payment_intent_ajax() {
try {
$is_nonce_valid = check_ajax_referer( 'wc_stripe_update_payment_intent_nonce', false, false );
if ( ! $is_nonce_valid ) {
throw new Exception( __( "We're not able to process this payment. Please refresh the page and try again.", 'woocommerce-gateway-stripe' ) );
}
$order_id = isset( $_POST['stripe_order_id'] ) ? absint( $_POST['stripe_order_id'] ) : null;
$payment_intent_id = isset( $_POST['wc_payment_intent_id'] ) ? wc_clean( wp_unslash( $_POST['wc_payment_intent_id'] ) ) : '';
$save_payment_method = isset( $_POST['save_payment_method'] ) ? 'yes' === wc_clean( wp_unslash( $_POST['save_payment_method'] ) ) : false;
$selected_upe_payment_type = ! empty( $_POST['selected_upe_payment_type'] ) ? wc_clean( wp_unslash( $_POST['selected_upe_payment_type'] ) ) : '';
$order_from_payment = WC_Stripe_Helper::get_order_by_intent_id( $payment_intent_id );
if ( ! $order_from_payment || $order_from_payment->get_id() !== $order_id ) {
throw new Exception( __( 'Unable to verify your request. Please reload the page and try again.', 'woocommerce-gateway-stripe' ) );
}
wp_send_json_success( $this->update_intent( $payment_intent_id, $order_id, $save_payment_method, $selected_upe_payment_type ), 200 );
} catch ( Exception $e ) {
// Send back error so it can be displayed to the customer.
wp_send_json_error(
[
'error' => [
'message' => $e->getMessage(),
],
]
);
}
}
/**
* Updates payment intent or setup intent to be able to save payment method.
*
* @since 5.6.0
* @version x.x.x
*
* @param {string} $payment_intent_id The id of the payment intent to update.
* @param {int} $order_id The id of the order if intent created from Order.
* @param {boolean} $save_payment_method True if saving the payment method.
* @param {string} $selected_upe_payment_type The name of the selected UPE payment type or empty string.
*
* @throws Exception If the update intent call returns with an error.
* @return array|null An array with result of the update, or nothing
*/
public function update_intent( $payment_intent_id = '', $order_id = null, $save_payment_method = false, $selected_upe_payment_type = '' ) {
$order = wc_get_order( $order_id );
if ( ! is_a( $order, 'WC_Order' ) ) {
return;
}
$gateway = $this->get_upe_gateway();
$amount = $order->get_total();
$currency = $order->get_currency();
$customer = new WC_Stripe_Customer( wp_get_current_user()->ID );
if ( $payment_intent_id ) {
$request = [
'metadata' => $gateway->get_metadata_from_order( $order ),
/* translators: 1) blog name 2) order number */
'description' => sprintf( __( '%1$s - Order %2$s', 'woocommerce-gateway-stripe' ), wp_specialchars_decode( get_bloginfo( 'name' ), ENT_QUOTES ), $order->get_order_number() ),
];
$is_setup_intent = substr( $payment_intent_id, 0, 4 ) === 'seti';
if ( ! $is_setup_intent ) {
// These parameters are only supported for payment intents.
$request['amount'] = WC_Stripe_Helper::get_stripe_amount( $amount, strtolower( $currency ) );
$request['currency'] = strtolower( $currency );
}
if ( '' !== $selected_upe_payment_type ) {
// Only update the payment_method_types if we have a reference to the payment type the customer selected.
$request['payment_method_types'] = [ $selected_upe_payment_type ];
if (
WC_Stripe_UPE_Payment_Method_CC::STRIPE_ID === $selected_upe_payment_type &&
in_array(
WC_Stripe_UPE_Payment_Method_Link::STRIPE_ID,
$gateway->get_upe_enabled_payment_method_ids(),
true
)
) {
$request['payment_method_types'] = [
WC_Stripe_UPE_Payment_Method_CC::STRIPE_ID,
WC_Stripe_UPE_Payment_Method_Link::STRIPE_ID,
];
}
$order->update_meta_data( '_stripe_upe_payment_type', $selected_upe_payment_type );
}
if ( ! empty( $customer ) && $customer->get_id() ) {
$request['customer'] = $customer->get_id();
}
if ( $save_payment_method ) {
$request['setup_future_usage'] = 'off_session';
}
$level3_data = $gateway->get_level3_data_from_order( $order );
// Use "setup_intents" endpoint if `$payment_intent_id` starts with `seti_`.
$endpoint = $is_setup_intent ? 'setup_intents' : 'payment_intents';
WC_Stripe_API::request_with_level3_data(
$request,
"{$endpoint}/{$payment_intent_id}",
$level3_data,
$order
);
$order->update_status( 'pending', __( 'Awaiting payment.', 'woocommerce-gateway-stripe' ) );
$order->save();
WC_Stripe_Helper::add_payment_intent_to_order( $payment_intent_id, $order );
}
return [
'success' => true,
];
}
/**
* Handle AJAX requests for creating a setup intent without confirmation for Stripe UPE.
*
* @since 5.6.0
* @version x.x.x
*/
public function init_setup_intent_ajax() {
try {
$is_nonce_valid = check_ajax_referer( 'wc_stripe_create_setup_intent_nonce', false, false );
if ( ! $is_nonce_valid ) {
throw new Exception( __( "We're not able to add this payment method. Please refresh the page and try again.", 'woocommerce-gateway-stripe' ) );
}
$payment_method_type = isset( $_POST['payment_method_type'] ) ? wc_clean( wp_unslash( $_POST['payment_method_type'] ) ) : '';
wp_send_json_success( $this->init_setup_intent( $payment_method_type ), 200 );
} catch ( Exception $e ) {
// Send back error, so it can be displayed to the customer.
wp_send_json_error(
[
'error' => [
'message' => $e->getMessage(),
],
]
);
}
}
/**
* Creates a setup intent without confirmation.
*
* @since 5.6.0
* @version x.x.x
*
* @param string|null $payment_method_type The type of payment method to use for the intent.
* @return array
* @throws Exception If customer for the current user cannot be read/found.
*/
public function init_setup_intent( $payment_method_type = null ) {
// Determine the customer managing the payment methods, create one if we don't have one already.
$user = wp_get_current_user();
$customer = new WC_Stripe_Customer( $user->ID );
if ( ! $customer->get_id() ) {
$customer_id = $customer->create_customer();
} else {
$customer_id = $customer->update_customer();
}
$gateway = $this->get_upe_gateway();
$enabled_payment_methods = $payment_method_type ? [ $payment_method_type ] : array_values( array_filter( $gateway->get_upe_enabled_payment_method_ids(), [ $gateway, 'is_enabled_for_saved_payments' ] ) );
$request = [
'customer' => $customer_id,
'confirm' => 'false',
'payment_method_types' => $enabled_payment_methods,
];
$request = $this->maybe_add_mandate_options( $request, $payment_method_type, true );
$setup_intent = WC_Stripe_API::request( $request, 'setup_intents' );
if ( ! empty( $setup_intent->error ) ) {
throw new Exception( $setup_intent->error->message );
}
return [
'id' => $setup_intent->id,
'client_secret' => $setup_intent->client_secret,
];
}
/**
* Handle AJAX request after authenticating payment at checkout.
*
* This function is used to update the order status after the user has
* been asked to authenticate their payment.
*
* This function is used for both:
* - regular checkout
* - Pay for Order page (in theory).
*
* @throws WC_Stripe_Exception
*/
public function update_order_status_ajax() {
$order = false;
try {
$is_nonce_valid = check_ajax_referer( 'wc_stripe_update_order_status_nonce', false, false );
if ( ! $is_nonce_valid ) {
throw new WC_Stripe_Exception( 'missing-nonce', __( 'CSRF verification failed.', 'woocommerce-gateway-stripe' ) );
}
$order_id = isset( $_POST['order_id'] ) ? absint( $_POST['order_id'] ) : false;
$order = wc_get_order( $order_id );
if ( ! $order ) {
throw new WC_Stripe_Exception( 'order_not_found', __( "We're not able to process this payment. Please try again later.", 'woocommerce-gateway-stripe' ) );
}
$intent_id = WC_Stripe_Helper::get_intent_id_from_order( $order );
$intent_id_received = isset( $_POST['intent_id'] ) ? wc_clean( wp_unslash( $_POST['intent_id'] ) ) : null;
if ( empty( $intent_id_received ) || $intent_id_received !== $intent_id ) {
$note = sprintf(
/* translators: %1: transaction ID of the payment or a translated string indicating an unknown ID. */
__( 'A payment with ID %s was used in an attempt to pay for this order. This payment intent ID does not match any payments for this order, so it was ignored and the order was not updated.', 'woocommerce-gateway-stripe' ),
$intent_id_received
);
$order->add_order_note( $note );
throw new WC_Stripe_Exception( 'invalid_intent_id', __( "We're not able to process this payment. Please try again later.", 'woocommerce-gateway-stripe' ) );
}
$save_payment_method = isset( $_POST['payment_method_id'] ) && ! empty( wc_clean( wp_unslash( $_POST['payment_method_id'] ) ) );
$gateway = $this->get_upe_gateway();
$gateway->process_order_for_confirmed_intent( $order, $intent_id_received, $save_payment_method );
wp_send_json_success(
[
'return_url' => $gateway->get_return_url( $order ),
],
200
);
} catch ( WC_Stripe_Exception $e ) {
wc_add_notice( $e->getLocalizedMessage(), 'error' );
WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() );
/* translators: error message */
if ( $order ) {
// Remove the awaiting confirmation order meta, don't save the order since it'll be saved in the next `update_status()` call.
WC_Stripe_Helper::remove_payment_awaiting_action( $order, false );
$order->update_status( 'failed' );
}
// Send back error so it can be displayed to the customer.
wp_send_json_error(
[
'error' => [
'message' => $e->getMessage(),
],
]
);
}
}
/**
* Handle AJAX request if error occurs while confirming intent.
* We will log the error and update the order.
*
* @throws WC_Stripe_Exception
*/
public function update_failed_order_ajax() {
$order = false;
try {
$is_nonce_valid = check_ajax_referer( 'wc_stripe_update_failed_order_nonce', false, false );
if ( ! $is_nonce_valid ) {
throw new WC_Stripe_Exception( 'missing-nonce', __( 'CSRF verification failed.', 'woocommerce-gateway-stripe' ) );
}
$order_id = isset( $_POST['order_id'] ) ? absint( $_POST['order_id'] ) : null;
$intent_id = isset( $_POST['intent_id'] ) ? wc_clean( wp_unslash( $_POST['intent_id'] ) ) : '';
$order = wc_get_order( $order_id );
$order_from_payment = WC_Stripe_Helper::get_order_by_intent_id( $intent_id );
if ( ! $order_from_payment || $order_from_payment->get_id() !== $order_id ) {
wp_send_json_error( __( 'Unable to verify your request. Please reload the page and try again.', 'woocommerce-gateway-stripe' ) );
}
if ( ! empty( $order_id ) && ! empty( $intent_id ) && is_object( $order ) ) {
$payment_needed = 0 < $order->get_total();
if ( $payment_needed ) {
$intent = WC_Stripe_API::retrieve( "payment_intents/$intent_id" );
} else {
$intent = WC_Stripe_API::retrieve( "setup_intents/$intent_id" );
}
$error = $intent->last_payment_error || $intent->error;
if ( ! empty( $error ) ) {
WC_Stripe_Logger::log( 'Error when processing payment: ' . $error->message );
throw new WC_Stripe_Exception( __( "We're not able to process this payment. Please try again later.", 'woocommerce-gateway-stripe' ) );
}
// Use the last charge within the intent to proceed.
$gateway = $this->get_gateway();
$charge = $gateway->get_latest_charge_from_intent( $intent );
if ( ! empty( $charge ) ) {
$gateway->process_response( $charge, $order );
} else {
// TODO: Add implementation for setup intents.
$gateway->process_response( $intent, $order );
}
$gateway->save_intent_to_order( $order, $intent );
}
} catch ( WC_Stripe_Exception $e ) {
// We are expecting an exception to be thrown here.
wc_add_notice( $e->getLocalizedMessage(), 'error' );
WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() );
do_action( 'wc_gateway_stripe_process_payment_error', $e, $order );
if ( $order ) {
$order->update_status( 'failed' );
}
}
wp_send_json_success();
}
/**
* Creates and confirm a payment intent with the given payment information.
* Used for dPE.
*
* @param array $payment_information The payment information needed for creating and confirming the intent.
*
* @throws WC_Stripe_Exception - If the create intent call returns with an error.
*
* @return stdClass
*/
public function create_and_confirm_payment_intent( $payment_information ) {
// Throws a WC_Stripe_Exception if required information is missing.
$required_params = [
'amount',
'currency',
'customer',
'level3',
'metadata',
'order',
'save_payment_method_to_store',
'shipping',
];
$non_empty_params = [];
// The payment method is not required if we're using the confirmation token flow.
if ( empty( $payment_information['confirmation_token'] ) ) {
$required_params[] = 'payment_method';
$required_params[] = 'capture_method';
$non_empty_params[] = 'payment_method';
}
$instance_params = [ 'order' => 'WC_Order' ];
$this->validate_payment_intent_required_params( $required_params, $non_empty_params, $instance_params, $payment_information );
$order = $payment_information['order'];
$selected_payment_type = $payment_information['selected_payment_type'];
$payment_method_types = $payment_information['payment_method_types'];
$is_using_saved_token = $payment_information['is_using_saved_payment_method'] ?? false;
$request = $this->build_base_payment_intent_request_params( $payment_information );
$request = array_merge(
$request,
[
'amount' => $payment_information['amount'],
'confirm' => 'true',
'currency' => $payment_information['currency'],
'customer' => $payment_information['customer'],
/* translators: 1) blog name 2) order number */
'description' => sprintf( __( '%1$s - Order %2$s', 'woocommerce-gateway-stripe' ), wp_specialchars_decode( get_bloginfo( 'name' ), ENT_QUOTES ), $order->get_order_number() ),
'metadata' => $payment_information['metadata'],
'payment_method_types' => $payment_method_types,
]
);
if ( isset( $payment_information['statement_descriptor_suffix'] ) ) {
$request['statement_descriptor_suffix'] = $payment_information['statement_descriptor_suffix'];
}
if ( ! empty( $payment_information['payment_method_options'] ) ) {
$request['payment_method_options'] = $payment_information['payment_method_options'];
}
// Using a saved token will also be confirmed immediately. For voucher and wallet payment methods type like Boleto, Oxxo, Multibanco, and Cash App we shouldn't confirm
// the intent immediately as this is done on the front-end when displaying the voucher to the customer.
// When the intent is confirmed, Stripe sends a webhook to the store which puts the order on-hold, which we only want to happen after successfully displaying the voucher.
if ( ! $is_using_saved_token && $this->is_delayed_confirmation_required( $payment_method_types ) ) {
$request['confirm'] = 'false';
}
// Run the necessary filter to make sure mandate information is added when it's required.
$request = apply_filters(
'wc_stripe_generate_create_intent_request',
$request,
$order,
null // $prepared_source parameter is not necessary for adding mandate information.
);
$payment_intent = WC_Stripe_API::request_with_level3_data(
$request,
'payment_intents',
$payment_information['level3'],
$order
);
// Only update the payment_type if we have a reference to the payment type the customer selected.
if ( '' !== $selected_payment_type ) {
$order->update_meta_data( '_stripe_upe_payment_type', $selected_payment_type );
}
return $payment_intent;
}
/**
* Adds mandate options to the request if required.
*
* @param array $request The request array to add the mandate options to.
* @param string|null $payment_method_type The type of payment method to use for the intent.
* @param bool $is_setup_intent Whether the request is for a setup intent.
*
* @return array
*/
private function maybe_add_mandate_options( $request, $payment_method_type, $is_setup_intent = false ) {
if ( WC_Stripe_UPE_Payment_Method_ACSS::STRIPE_ID === $payment_method_type ) {
$request['payment_method_options'] = [
WC_Stripe_Payment_Methods::ACSS_DEBIT => [
'mandate_options' => [
'payment_schedule' => 'combined',
'interval_description' => __( 'Payments as per agreement', 'woocommerce-gateway-stripe' ),
'transaction_type' => 'personal',
],
],
];
// If it's a setup intent, add the CAD currency parameter.
if ( $is_setup_intent ) {
$request['payment_method_options'][ WC_Stripe_Payment_Methods::ACSS_DEBIT ]['currency'] = strtolower( WC_Stripe_Currency_Code::CANADIAN_DOLLAR );
}
}
return $request;
}
/**
* Updates and confirm a payment intent with the given payment information.
* Used for dPE.
*
* @param object $payment_intent The payment intent to update.
* @param array $payment_information The payment information needed for creating and confirming the intent.
*
* @throws WC_Stripe_Exception - If any of the required information is missing.
*
* @return array
*/
public function update_and_confirm_payment_intent( $payment_intent, $payment_information ) {
// Throws a WC_Stripe_Exception if required information is missing.
$required_params = [
'shipping',
'selected_payment_type',
'payment_method_types',
'level3',
'order',
'save_payment_method_to_store',
];
// The payment method is not required if we're using the confirmation token flow.
if ( empty( $payment_information['confirmation_token'] ) ) {
$required_params[] = 'payment_method';
$required_params[] = 'capture_method';
}
$instance_params = [ 'order' => 'WC_Order' ];
$this->validate_payment_intent_required_params( $required_params, [], $instance_params, $payment_information );
$request = $this->build_base_payment_intent_request_params( $payment_information );
$order = $payment_information['order'];
// Run the necessary filter to make sure mandate information is added when it's required.
$request = apply_filters(
'wc_stripe_generate_create_intent_request',
$request,
$order,
null // $prepared_source parameter is not necessary for adding mandate information.
);
return WC_Stripe_API::request_with_level3_data(
$request,
"payment_intents/{$payment_intent->id}/confirm",
$payment_information['level3'],
$order
);
}
/**
* Determines if the request contains all the required params for creating or updating a payment intent.
*
* @param array $required_params The required parameters for the payment intent.
* @param array $non_empty_params The parameters that must not contain an empty value.
* @param array $instance_params The parameters that must be of a specific type.
* @param array $payment_information The payment information to be validated.
* @return void
* @throws WC_Stripe_Exception
*/
private function validate_payment_intent_required_params( $required_params, $non_empty_params, $instance_params, $payment_information ) {
$missing_params = [];
foreach ( $required_params as $param ) {
// Check if they're set. Some can be null.
if ( ! array_key_exists( $param, $payment_information ) ) {
$missing_params[] = $param;
}
}
// Some params must not contain an empty value.
foreach ( $non_empty_params as $param ) {
if ( empty( $payment_information[ $param ] ) ) {
$missing_params[] = $param;
}
}
$shopper_error_message = __( 'There was a problem processing the payment.', 'woocommerce-gateway-stripe' );
// Bail out if we're missing required information.
if ( ! empty( $missing_params ) ) {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_debug_backtrace
$calling_method = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS, 2 )[1]['function'] ?? '';
throw new WC_Stripe_Exception(
sprintf(
'The information for creating and confirming the intent is missing the following data: %s. Payment information received: %s. Calling method: %s',
implode( ', ', $missing_params ),
wp_json_encode( $payment_information ),
$calling_method
),
$shopper_error_message
);
}
// Check if the instance params are of the correct type.
foreach ( $instance_params as $param => $type ) {
if ( ! is_a( $payment_information[ $param ], $type ) ) {
throw new WC_Stripe_Exception(
sprintf(
'The provided value for the "%s" parameter is not a %s.',
$param,
$type
),
__( 'Please reach out to us if the problem persists.', 'woocommerce-gateway-stripe' )
);
}
}
}
/**
* Builds the base request parameters for creating/updating and confirming a payment intent.
*
* @param array $payment_information The payment information needed for creating/updating and confirming the intent.
*
* @return array The request parameters for creating/updating and confirming a payment intent.
*/
private function build_base_payment_intent_request_params( $payment_information ) {
$selected_payment_type = $payment_information['selected_payment_type'];
$payment_method_types = $payment_information['payment_method_types'];
$request = [
'shipping' => $payment_information['shipping'],
];
$is_using_confirmation_token = ! empty( $payment_information['confirmation_token'] );
if ( $is_using_confirmation_token ) {
$request['confirmation_token'] = $payment_information['confirmation_token'];
} else {
$request['payment_method'] = $payment_information['payment_method'];
$request['capture_method'] = $payment_information['capture_method'];
}
// For Stripe Link & SEPA with deferred intent UPE, we must create mandate to acknowledge that terms have been shown to customer.
if ( ! $is_using_confirmation_token && $this->is_mandate_data_required( $selected_payment_type ) ) {
$request = WC_Stripe_Helper::add_mandate_data( $request );
}
$request = $this->maybe_add_mandate_options( $request, $payment_information['selected_payment_type'] );
// Does not set the return URL if Single Payment Element is enabled or if the request needs redirection.
if ( $this->get_upe_gateway()->is_spe_enabled() || $this->request_needs_redirection( $payment_method_types ) ) {
$request['return_url'] = $payment_information['return_url'];
}
// If the customer is saving the payment method to the store or has a subscription, we should set the setup_future_usage to off_session.
// Only exception is when using a confirmation token. For confirmations tokens, the setup_future_usage is set within the payment method.
if ( ! $is_using_confirmation_token && ( $payment_information['save_payment_method_to_store'] || ! empty( $payment_information['has_subscription'] ) ) ) {
$request['setup_future_usage'] = 'off_session';
}
return $request;
}
/**
* Determines if mandate data is required for deferred intent UPE payment.
*
* A mandate must be provided before a deferred intent UPE payment can be processed.