-
Notifications
You must be signed in to change notification settings - Fork 207
/
Copy pathclass-wc-stripe-webhook-handler.php
1328 lines (1096 loc) · 45.4 KB
/
class-wc-stripe-webhook-handler.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;
}
/**
* Class WC_Stripe_Webhook_Handler.
*
* Handles webhooks from Stripe on sources that are not immediately chargeable.
*
* @since 4.0.0
*/
class WC_Stripe_Webhook_Handler extends WC_Stripe_Payment_Gateway {
/**
* Is test mode active?
*
* @var bool
*/
public $testmode;
/**
* The secret to use when verifying webhooks.
*
* @var string
*/
protected $secret;
/**
* The Action Scheduler service.
*
* @var WC_Stripe_Action_Scheduler_Service
*/
protected $action_scheduler_service;
/**
* How long to wait before processing a deferred webhook.
*
* @var int
*/
protected $deferred_webhook_delay = 2 * MINUTE_IN_SECONDS;
/**
* The Action Scheduler hook to use when retrying a webhook.
*
* @var string
*/
protected $deferred_webhook_action = 'wc_stripe_deferred_webhook';
/**
* Constructor.
*
* @since 4.0.0
* @version 5.0.0
*/
public function __construct() {
$this->retry_interval = 2;
$stripe_settings = WC_Stripe_Helper::get_stripe_settings();
$this->testmode = WC_Stripe_Mode::is_test();
$secret_key = ( $this->testmode ? 'test_' : '' ) . 'webhook_secret';
$this->secret = ! empty( $stripe_settings[ $secret_key ] ) ? $stripe_settings[ $secret_key ] : false;
$this->action_scheduler_service = new WC_Stripe_Action_Scheduler_Service();
add_action( 'woocommerce_api_wc_stripe', [ $this, 'check_for_webhook' ] );
// Get/set the time we began monitoring the health of webhooks by fetching it.
// This should be roughly the same as the activation time of the version of the
// plugin when this code first appears.
WC_Stripe_Webhook_State::get_monitoring_began_at();
add_action( $this->deferred_webhook_action, [ $this, 'process_deferred_webhook' ], 10, 2 );
}
/**
* Check incoming requests for Stripe Webhook data and process them.
*
* @since 4.0.0
* @version 5.0.0
*/
public function check_for_webhook() {
if ( ! isset( $_SERVER['REQUEST_METHOD'] )
|| ( 'POST' !== $_SERVER['REQUEST_METHOD'] )
|| ! isset( $_GET['wc-api'] )
|| ( 'wc_stripe' !== $_GET['wc-api'] )
) {
return;
}
try {
$request_body = file_get_contents( 'php://input' );
$event = json_decode( $request_body );
$event_type = $event->type ?? 'No event type found';
} catch ( Exception $e ) {
WC_Stripe_Logger::error( 'Webhook body could not be retrieved: ' . $e->getMessage() );
return;
}
WC_Stripe_Logger::debug( 'Webhook received: ' . $event_type );
// Validate it to make sure it is legit.
$request_headers = array_change_key_case( $this->get_request_headers(), CASE_UPPER );
$validation_result = $this->validate_request( $request_headers, $request_body );
if ( WC_Stripe_Webhook_State::VALIDATION_SUCCEEDED === $validation_result ) {
WC_Stripe_Logger::debug( 'Webhook body: ' . print_r( $request_body, true ) ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
$this->process_webhook( $request_body );
WC_Stripe_Webhook_State::set_last_webhook_success_at( $event->created );
status_header( 200 );
exit;
} else {
WC_Stripe_Logger::error( 'Webhook failed validation. Reason: ' . $validation_result );
WC_Stripe_Logger::error( 'Webhook body: ' . print_r( $request_body, true ) ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
WC_Stripe_Webhook_State::set_last_webhook_failure_at( time() );
if ( WC_Stripe_Webhook_State::VALIDATION_FAILED_SIGNATURE_MISMATCH === $validation_result && $this->has_duplicate_webhooks_setup() ) {
WC_Stripe_Webhook_State::set_last_error_reason( WC_Stripe_Webhook_State::VALIDATION_FAILED_DUPLICATE_WEBHOOKS );
// Return a 400 HTTP status code to notify Stripe about a misconfigured webhook when the signature does not match.
// @see https://docs.stripe.com/webhooks#disable
status_header( 400 );
exit;
}
WC_Stripe_Webhook_State::set_last_error_reason( $validation_result );
// A webhook endpoint must return a 2xx HTTP status code to prevent future webhook
// delivery failures.
// @see https://docs.stripe.com/webhooks#acknowledge-events-immediately
status_header( 204 );
exit;
}
}
/**
* Check if the Stripe account has duplicate webhooks setup for this site.
*
* @since 9.1.0
*/
public function has_duplicate_webhooks_setup() {
$webhook_url = WC_Stripe_Helper::get_webhook_url();
$webhooks = WC_Stripe_API::retrieve( 'webhook_endpoints' );
if ( is_wp_error( $webhooks ) || ! isset( $webhooks->data ) || empty( $webhooks->data ) ) {
return false;
}
$number_of_webhooks = 0;
foreach ( $webhooks->data as $webhook ) {
if ( ! isset( $webhook->url ) ) {
continue;
}
if ( $webhook->url === $webhook_url ) {
$number_of_webhooks++;
}
}
return $number_of_webhooks > 1;
}
/**
* Verify the incoming webhook notification to make sure it is legit.
*
* @since 4.0.0
* @version 5.0.0
* @param array $request_headers The request headers from Stripe.
* @param array $request_body The request body from Stripe.
* @return string The validation result (e.g. self::VALIDATION_SUCCEEDED )
*/
public function validate_request( $request_headers, $request_body ) {
if ( empty( $request_headers ) ) {
return WC_Stripe_Webhook_State::VALIDATION_FAILED_EMPTY_HEADERS;
}
if ( empty( $request_body ) ) {
return WC_Stripe_Webhook_State::VALIDATION_FAILED_EMPTY_BODY;
}
if ( empty( $this->secret ) ) {
return WC_Stripe_Webhook_State::VALIDATION_FAILED_EMPTY_SECRET;
}
// Check for a valid signature.
$signature_format = '/^t=(?P<timestamp>\d+)(?P<signatures>(,v\d+=[a-z0-9]+){1,2})$/';
if ( empty( $request_headers['STRIPE-SIGNATURE'] ) || ! preg_match( $signature_format, $request_headers['STRIPE-SIGNATURE'], $matches ) ) {
return WC_Stripe_Webhook_State::VALIDATION_FAILED_SIGNATURE_INVALID;
}
// Verify the timestamp.
$timestamp = intval( $matches['timestamp'] );
if ( abs( $timestamp - time() ) > 5 * MINUTE_IN_SECONDS ) {
return WC_Stripe_Webhook_State::VALIDATION_FAILED_TIMESTAMP_MISMATCH;
}
// Generate the expected signature.
$signed_payload = $timestamp . '.' . $request_body;
$expected_signature = hash_hmac( 'sha256', $signed_payload, $this->secret );
// Check if the expected signature is present.
if ( ! preg_match( '/,v\d+=' . preg_quote( $expected_signature, '/' ) . '/', $matches['signatures'] ) ) {
return WC_Stripe_Webhook_State::VALIDATION_FAILED_SIGNATURE_MISMATCH;
}
return WC_Stripe_Webhook_State::VALIDATION_SUCCEEDED;
}
/**
* Gets the incoming request headers. Some servers are not using
* Apache and "getallheaders()" will not work so we may need to
* build our own headers.
*
* @since 4.0.0
* @version 4.0.0
*/
public function get_request_headers() {
if ( ! function_exists( 'getallheaders' ) ) {
$headers = [];
foreach ( $_SERVER as $name => $value ) {
if ( 'HTTP_' === substr( $name, 0, 5 ) ) {
$headers[ str_replace( ' ', '-', ucwords( strtolower( str_replace( '_', ' ', substr( $name, 5 ) ) ) ) ) ] = $value;
}
}
return $headers;
} else {
return getallheaders();
}
}
/**
* Process webhook payments.
* This is where we charge the source.
*
* @since 4.0.0
* @version 4.0.0
* @param object $notification
* @param bool $retry
*/
public function process_webhook_payment( $notification, $retry = true ) {
// The following 3 payment methods are synchronous so does not need to be handle via webhook.
if ( WC_Stripe_Payment_Methods::CARD === $notification->data->object->type || WC_Stripe_Payment_Methods::SEPA_DEBIT === $notification->data->object->type || 'three_d_secure' === $notification->data->object->type ) {
return;
}
$order = WC_Stripe_Helper::get_order_by_source_id( $notification->data->object->id );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via source ID: ' . $notification->data->object->id );
return;
}
$order_id = $order->get_id();
$is_pending_receiver = ( 'receiver' === $notification->data->object->flow );
if ( $this->lock_order_payment( $order ) ) {
return;
}
try {
if ( $order->has_status( [ 'processing', 'completed' ] ) ) {
return;
}
if ( $order->has_status( 'on-hold' ) && ! $is_pending_receiver ) {
return;
}
// Result from Stripe API request.
$response = null;
// This will throw exception if not valid.
$this->validate_minimum_order_amount( $order );
WC_Stripe_Logger::log( "Info: (Webhook) Begin processing payment for order $order_id for the amount of {$order->get_total()}" );
// Prep source object.
$prepared_source = $this->prepare_order_source( $order );
// Make the request.
$response = WC_Stripe_API::request( $this->generate_payment_request( $order, $prepared_source ), 'charges', 'POST', true );
$headers = $response['headers'];
$response = $response['body'];
if ( ! empty( $response->error ) ) {
// Customer param wrong? The user may have been deleted on stripe's end. Remove customer_id. Can be retried without.
if ( $this->is_no_such_customer_error( $response->error ) ) {
delete_user_option( $order->get_customer_id(), '_stripe_customer_id' );
$order->delete_meta_data( '_stripe_customer_id' );
$order->save();
}
if ( $this->is_no_such_token_error( $response->error ) && $prepared_source->token_id ) {
// Source param wrong? The CARD may have been deleted on stripe's end. Remove token and show message.
$wc_token = WC_Payment_Tokens::get( $prepared_source->token_id );
$wc_token->delete();
$localized_message = __( 'This card is no longer available and has been removed.', 'woocommerce-gateway-stripe' );
$order->add_order_note( $localized_message );
throw new WC_Stripe_Exception( print_r( $response, true ), $localized_message );
}
// We want to retry.
if ( $this->is_retryable_error( $response->error ) ) {
// Unlock the order before retrying.
$this->unlock_order_payment( $order );
if ( $retry ) {
// Don't do anymore retries after this.
if ( 5 <= $this->retry_interval ) {
return $this->process_webhook_payment( $notification, false );
}
sleep( $this->retry_interval );
$this->retry_interval++;
return $this->process_webhook_payment( $notification, true );
} else {
$localized_message = __( 'Sorry, we are unable to process your payment at this time. Please retry later.', 'woocommerce-gateway-stripe' );
$order->add_order_note( $localized_message );
throw new WC_Stripe_Exception( print_r( $response, true ), $localized_message );
}
}
$localized_messages = WC_Stripe_Helper::get_localized_messages();
if ( 'card_error' === $response->error->type ) {
$localized_message = isset( $localized_messages[ $response->error->code ] ) ? $localized_messages[ $response->error->code ] : $response->error->message;
} else {
$localized_message = isset( $localized_messages[ $response->error->type ] ) ? $localized_messages[ $response->error->type ] : $response->error->message;
}
$order->add_order_note( $localized_message );
throw new WC_Stripe_Exception( print_r( $response, true ), $localized_message );
}
// To prevent double processing the order on WC side.
if ( ! $this->is_original_request( $headers ) ) {
return;
}
do_action( 'wc_gateway_stripe_process_webhook_payment', $response, $order );
$this->process_response( $response, $order );
} catch ( WC_Stripe_Exception $e ) {
WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() );
do_action( 'wc_gateway_stripe_process_webhook_payment_error', $order, $notification, $e );
$statuses = [ 'pending', 'failed' ];
if ( $order->has_status( $statuses ) ) {
$this->send_failed_order_email( $order_id );
}
}
$this->unlock_order_payment( $order );
}
/**
* Process webhook dispute that is created.
* This is triggered when fraud is detected or customer processes chargeback.
* We want to put the order into on-hold and add an order note.
*
* @since 4.0.0
* @param object $notification
*/
public function process_webhook_dispute( $notification ) {
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->charge );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $notification->data->object->charge );
return;
}
$this->set_stripe_order_status_before_hold( $order, $order->get_status() );
$needs_response = in_array( $notification->data->object->status, [ 'needs_response', 'warning_needs_response' ], true );
if ( $needs_response ) {
$message = sprintf(
/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag */
__( 'A dispute was created for this order. Response is needed. Please go to your %1$sStripe Dashboard%2$s to review this dispute.', 'woocommerce-gateway-stripe' ),
'<a href="' . esc_url( $this->get_transaction_url( $order ) ) . '" title="Stripe Dashboard" target="_blank">',
'</a>'
);
} else {
$message = __( 'A dispute was created for this order.', 'woocommerce-gateway-stripe' );
}
if ( ! $order->has_status( 'cancelled' ) && ! $order->get_meta( '_stripe_status_final', false ) ) {
$order->update_status( 'on-hold', $message );
} else {
$order->add_order_note( $message );
$order->save();
}
do_action( 'wc_gateway_stripe_process_webhook_payment_error', $order, $notification );
$order_id = $order->get_id();
$this->send_failed_order_email( $order_id );
}
/**
* Process webhook dispute that is closed.
*
* @since 4.4.1
* @param object $notification
*/
public function process_webhook_dispute_closed( $notification ) {
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->charge );
$status = $notification->data->object->status;
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $notification->data->object->charge );
return;
}
if ( 'lost' === $status ) {
$message = __( 'The dispute was lost or accepted.', 'woocommerce-gateway-stripe' );
} elseif ( 'won' === $status ) {
$message = __( 'The dispute was resolved in your favor.', 'woocommerce-gateway-stripe' );
} elseif ( 'warning_closed' === $status ) {
$message = __( 'The inquiry or retrieval was closed.', 'woocommerce-gateway-stripe' );
} else {
return;
}
if ( apply_filters( 'wc_stripe_webhook_dispute_change_order_status', true, $order, $notification ) ) {
// Mark final so that order status is not overridden by out-of-sequence events.
$order->update_meta_data( '_stripe_status_final', true );
// Fail order if dispute is lost, or else revert to pre-dispute status.
$order_status = 'lost' === $status ? 'failed' : $this->get_stripe_order_status_before_hold( $order );
// Do not re-send "Processing Order" email to customer after a dispute win.
if ( 'processing' === $order_status ) {
$emails = WC()->mailer()->get_emails();
if ( isset( $emails['WC_Email_Customer_Processing_Order'] ) ) {
$callback = [ $emails['WC_Email_Customer_Processing_Order'], 'trigger' ];
remove_action(
'woocommerce_order_status_on-hold_to_processing_notification',
$callback
);
}
}
$order->update_status( $order_status, $message );
} else {
$order->add_order_note( $message );
}
}
/**
* Process webhook capture. This is used for an authorized only
* transaction that is later captured via Stripe not WC.
*
* @since 4.0.0
* @version 4.0.0
* @param object $notification
*/
public function process_webhook_capture( $notification ) {
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->id );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $notification->data->object->id );
return;
}
if ( WC_Stripe_Helper::payment_method_allows_manual_capture( $order->get_payment_method() ) ) {
$charge = $order->get_transaction_id();
$captured = $order->get_meta( '_stripe_charge_captured', true );
if ( $charge && 'no' === $captured ) {
$order->update_meta_data( '_stripe_charge_captured', 'yes' );
// Store other data such as fees
$order->set_transaction_id( $notification->data->object->id );
if ( isset( $notification->data->object->balance_transaction ) ) {
$this->update_fees( $order, $notification->data->object->balance_transaction );
}
// Check and see if capture is partial.
if ( $this->is_partial_capture( $notification ) ) {
$partial_amount = $this->get_partial_amount_to_charge( $notification );
$order->set_total( $partial_amount );
$refund_object = $this->get_refund_object( $notification );
$this->update_fees( $order, $refund_object->balance_transaction );
/* translators: partial captured amount */
$order->add_order_note( sprintf( __( 'This charge was partially captured via Stripe Dashboard in the amount of: %s', 'woocommerce-gateway-stripe' ), $partial_amount ) );
} else {
$order->payment_complete( $notification->data->object->id );
/* translators: transaction id */
$order->add_order_note( sprintf( __( 'Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $notification->data->object->id ) );
}
if ( is_callable( [ $order, 'save' ] ) ) {
$order->save();
}
}
}
}
/**
* Process webhook charge succeeded. This is used for payment methods
* that takes time to clear which is asynchronous. e.g. SEPA, Sofort.
*
* @since 4.0.0
* @version 4.0.0
* @param object $notification
*/
public function process_webhook_charge_succeeded( $notification ) {
// The following payment methods are synchronous so does not need to be handle via webhook.
if ( ( isset( $notification->data->object->source->type ) && WC_Stripe_Payment_Methods::CARD === $notification->data->object->source->type ) || ( isset( $notification->data->object->source->type ) && 'three_d_secure' === $notification->data->object->source->type ) ) {
return;
}
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->id );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $notification->data->object->id );
return;
}
if ( ! $order->has_status( 'on-hold' ) ) {
return;
}
// When the plugin's "Issue an authorization on checkout, and capture later"
// setting is enabled, Stripe API still sends a "charge.succeeded" webhook but
// the payment has not been captured, yet. This ensures that the payment has been
// captured, before completing the payment.
if ( ! $notification->data->object->captured ) {
return;
}
// Store other data such as fees
$order->set_transaction_id( $notification->data->object->id );
if ( isset( $notification->data->object->balance_transaction ) ) {
$this->update_fees( $order, $notification->data->object->balance_transaction );
}
/**
* If the response has a succeeded status but also has a risk/fraud outcome that requires manual review, don't mark the order as
* processing/completed. This will be handled by the incoming review.open webhook.
*
* Depending on when Stripe sends their events and how quickly it is processed by the store, the review.open webhook (which marks orders as on-hold)
* can be processed before or after the payment_intent.success webhook. This difference can lead to orders being incorrectly marked as processing/completed
* in WooCommerce, but flagged for manual renewal in Stripe.
*
* If the review.open webhook was processed before the payment_intent.success, set the processing/completed status in `_stripe_status_before_hold`
* to ensure the review.closed event handler will update the status to the proper status.
*/
if ( 'manual_review' !== $this->get_risk_outcome( $notification ) ) {
$order->payment_complete( $notification->data->object->id );
/* translators: transaction id */
$order->add_order_note( sprintf( __( 'Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $notification->data->object->id ) );
}
if ( is_callable( [ $order, 'save' ] ) ) {
$order->save();
}
}
/**
* Process webhook charge failed.
*
* @since 4.0.0
* @since 4.1.5 Can handle any fail payments from any methods.
* @since 9.0.0 Can handle payment expiration.
* @param object $notification
*/
public function process_webhook_charge_failed( $notification ) {
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->id );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $notification->data->object->id );
return;
}
// If order status is already in failed status don't continue.
if ( $order->has_status( 'failed' ) ) {
return;
}
if ( 'charge.expired' === $notification->type ) {
$message = __( 'This payment has expired.', 'woocommerce-gateway-stripe' );
} else {
$message = __( 'This payment failed to clear.', 'woocommerce-gateway-stripe' );
}
if ( ! $order->get_meta( '_stripe_status_final', false ) ) {
$order->update_status( 'failed', $message );
} else {
$order->add_order_note( $message );
}
do_action( 'wc_gateway_stripe_process_webhook_payment_error', $order, $notification );
}
/**
* Process webhook source canceled. This is used for payment methods
* that redirects and awaits payments from customer.
*
* @since 4.0.0
* @since 4.1.15 Add check to make sure order is processed by Stripe.
* @param object $notification
*/
public function process_webhook_source_canceled( $notification ) {
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->id );
// If can't find order by charge ID, try source ID.
if ( ! $order ) {
$order = WC_Stripe_Helper::get_order_by_source_id( $notification->data->object->id );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via charge/source ID: ' . $notification->data->object->id );
return;
}
}
// Don't proceed if payment method isn't Stripe.
if ( 'stripe' !== $order->get_payment_method() ) {
WC_Stripe_Logger::log( 'Canceled webhook abort: Order was not processed by Stripe: ' . $order->get_id() );
return;
}
$message = __( 'This payment was cancelled.', 'woocommerce-gateway-stripe' );
if ( ! $order->has_status( 'cancelled' ) && ! $order->get_meta( '_stripe_status_final', false ) ) {
$order->update_status( 'cancelled', $message );
} else {
$order->add_order_note( $message );
}
do_action( 'wc_gateway_stripe_process_webhook_payment_error', $order, $notification );
}
/**
* Process webhook refund.
*
* @since 4.0.0
* @version 4.9.0
* @param object $notification
*/
public function process_webhook_refund( $notification ) {
$refund_object = $this->get_refund_object( $notification );
$order = WC_Stripe_Helper::get_order_by_refund_id( $refund_object->id );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via refund ID: ' . $refund_object->id );
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->id );
}
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $notification->data->object->id );
return;
}
$order_id = $order->get_id();
if ( 'stripe' === substr( (string) $order->get_payment_method(), 0, 6 ) ) {
$charge = $order->get_transaction_id();
$captured = $order->get_meta( '_stripe_charge_captured' );
$refund_id = $order->get_meta( '_stripe_refund_id' );
$currency = $order->get_currency();
$raw_amount = $refund_object->amount;
if ( ! in_array( strtolower( $currency ), WC_Stripe_Helper::no_decimal_currencies(), true ) ) {
$raw_amount /= 100;
}
$amount = wc_price( $raw_amount, [ 'currency' => $currency ] );
// If charge wasn't captured, skip creating a refund.
if ( 'yes' !== $captured ) {
// If the process was initiated from wp-admin,
// the order was already cancelled, so we don't need a new note.
if ( 'cancelled' !== $order->get_status() ) {
/* translators: amount (including currency symbol) */
$order->add_order_note( sprintf( __( 'Pre-Authorization for %s voided from the Stripe Dashboard.', 'woocommerce-gateway-stripe' ), $amount ) );
$order->update_status( 'cancelled' );
}
return;
}
if ( $this->lock_order_refund( $order ) ) {
return;
}
// If the refund ID matches, don't continue to prevent double refunding.
if ( $refund_object->id === $refund_id ) {
return;
}
if ( $charge ) {
$reason = __( 'Refunded via Stripe Dashboard', 'woocommerce-gateway-stripe' );
// Create the refund.
$refund = wc_create_refund(
[
'order_id' => $order_id,
'amount' => $this->get_refund_amount( $notification ),
'reason' => $reason,
]
);
if ( is_wp_error( $refund ) ) {
WC_Stripe_Logger::log( $refund->get_error_message() );
}
$order->update_meta_data( '_stripe_refund_id', $refund_object->id );
if ( isset( $refund_object->balance_transaction ) ) {
$this->update_fees( $order, $refund_object->balance_transaction );
}
$this->unlock_order_refund( $order );
/* translators: 1) amount (including currency symbol) 2) transaction id 3) refund message */
$order->add_order_note( sprintf( __( 'Refunded %1$s - Refund ID: %2$s - %3$s', 'woocommerce-gateway-stripe' ), $amount, $refund_object->id, $reason ) );
}
}
}
/**
* Process a refund update.
*
* @param object $notification
*/
public function process_webhook_refund_updated( $notification ) {
$refund_object = $notification->data->object;
$order = WC_Stripe_Helper::get_order_by_charge_id( $refund_object->charge );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order to update refund via charge ID: ' . $refund_object->charge );
return;
}
$order_id = $order->get_id();
if ( 'stripe' === substr( (string) $order->get_payment_method(), 0, 6 ) ) {
$charge = $order->get_transaction_id();
$refund_id = $order->get_meta( '_stripe_refund_id' );
$currency = $order->get_currency();
$raw_amount = $refund_object->amount;
if ( ! in_array( strtolower( $currency ), WC_Stripe_Helper::no_decimal_currencies(), true ) ) {
$raw_amount /= 100;
}
$amount = wc_price( $raw_amount, [ 'currency' => $currency ] );
// If the refund IDs do not match stop.
if ( $refund_object->id !== $refund_id ) {
return;
}
if ( $charge ) {
$refunds = wc_get_orders(
[
'limit' => 1,
'parent' => $order_id,
]
);
if ( empty( $refunds ) ) {
// No existing refunds nothing to update.
return;
}
$refund = $refunds[0];
if ( in_array( $refund_object->status, [ 'failed', 'canceled' ], true ) ) {
if ( isset( $refund_object->failure_balance_transaction ) ) {
$this->update_fees( $order, $refund_object->failure_balance_transaction );
}
$refund->delete( true );
do_action( 'woocommerce_refund_deleted', $refund_id, $order_id );
if ( 'failed' === $refund_object->status ) {
/* translators: 1) amount (including currency symbol) 2) transaction id 3) refund failure code */
$note = sprintf( __( 'Refund failed for %1$s - Refund ID: %2$s - Reason: %3$s', 'woocommerce-gateway-stripe' ), $amount, $refund_object->id, $refund_object->failure_reason );
} else {
/* translators: 1) amount (including currency symbol) 2) transaction id 3) refund failure code */
$note = sprintf( __( 'Refund canceled for %1$s - Refund ID: %2$s - Reason: %3$s', 'woocommerce-gateway-stripe' ), $amount, $refund_object->id, $refund_object->failure_reason );
}
$order->add_order_note( $note );
}
}
}
}
/**
* Process webhook reviews that are opened. i.e Radar.
*
* @since 4.0.6
* @param object $notification
*/
public function process_review_opened( $notification ) {
if ( isset( $notification->data->object->payment_intent ) ) {
$order = WC_Stripe_Helper::get_order_by_intent_id( $notification->data->object->payment_intent );
if ( ! $order ) {
WC_Stripe_Logger::log( '[Review Opened] Could not find order via intent ID: ' . $notification->data->object->payment_intent );
return;
}
} else {
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->charge );
if ( ! $order ) {
WC_Stripe_Logger::log( '[Review Opened] Could not find order via charge ID: ' . $notification->data->object->charge );
return;
}
}
$this->set_stripe_order_status_before_hold( $order, $order->get_status() );
$message = sprintf(
/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag 3) The reason type. */
__( 'A review has been opened for this order. Action is needed. Please go to your %1$sStripe Dashboard%2$s to review the issue. Reason: (%3$s).', 'woocommerce-gateway-stripe' ),
'<a href="' . esc_url( $this->get_transaction_url( $order ) ) . '" title="Stripe Dashboard" target="_blank">',
'</a>',
esc_html( $notification->data->object->reason )
);
if ( apply_filters( 'wc_stripe_webhook_review_change_order_status', true, $order, $notification ) && ! $order->get_meta( '_stripe_status_final', false ) ) {
$order->update_status( 'on-hold', $message );
} else {
$order->add_order_note( $message );
$order->save(); // update_status() calls save on the order, so make sure we manually call save() when not updating the status to ensure meta is saved.
}
}
/**
* Process webhook reviews that are closed. i.e Radar.
*
* @since 4.0.6
* @param object $notification
*/
public function process_review_closed( $notification ) {
if ( isset( $notification->data->object->payment_intent ) ) {
$order = WC_Stripe_Helper::get_order_by_intent_id( $notification->data->object->payment_intent );
if ( ! $order ) {
WC_Stripe_Logger::log( '[Review Closed] Could not find order via intent ID: ' . $notification->data->object->payment_intent );
return;
}
} else {
$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->charge );
if ( ! $order ) {
WC_Stripe_Logger::log( '[Review Closed] Could not find order via charge ID: ' . $notification->data->object->charge );
return;
}
}
/* translators: 1) The reason type. */
$message = sprintf( __( 'The opened review for this order is now closed. Reason: (%s)', 'woocommerce-gateway-stripe' ), $notification->data->object->reason );
// Only change the status if the charge was captured, status is not final, the order is on-hold and the review was approved.
if ( 'yes' === $order->get_meta( '_stripe_charge_captured' ) &&
! $order->get_meta( '_stripe_status_final', false ) &&
$order->has_status( 'on-hold' ) &&
( ! empty( $notification->data->object->closed_reason ) && 'approved' === $notification->data->object->closed_reason ) &&
apply_filters( 'wc_stripe_webhook_review_change_order_status', true, $order, $notification )
) {
// If the status we stored before hold is an incomplete status, restore the status to processing/completed instead.
$status_after_review = $this->get_stripe_order_status_before_hold( $order );
if ( in_array( $status_after_review, apply_filters( 'woocommerce_valid_order_statuses_for_payment_complete', [ 'on-hold', 'pending', 'failed', 'cancelled' ], $order ), true ) ) {
$status_after_review = apply_filters( 'woocommerce_payment_complete_order_status', $order->needs_processing() ? 'processing' : 'completed', $order->get_id(), $order );
}
$order->update_status( $status_after_review, $message );
} else {
$order->add_order_note( $message );
}
}
/**
* Checks if capture is partial.
*
* @since 4.0.0
* @version 4.0.0
* @param object $notification
*/
public function is_partial_capture( $notification ) {
return 0 < $notification->data->object->amount_refunded;
}
/**
* Gets the first refund object from charge notification.
*
* @since 7.0.2
* @param object $notification
*
* @return object
*/
public function get_refund_object( $notification ) {
// Since API version 2022-11-15, the Charge object no longer expands `refunds` by default.
// We can remove this once we drop support for API versions prior to 2022-11-15.
if ( ! empty( $notification->data->object->refunds->data[0] ) ) {
return $notification->data->object->refunds->data[0];
}
$charge = $this->get_charge_object( $notification->data->object->id, [ 'expand' => [ 'refunds' ] ] );
return $charge->refunds->data[0];
}
/**
* Gets the amount refunded.
*
* @since 4.0.0
* @version 4.0.0
* @param object $notification
*/
public function get_refund_amount( $notification ) {
if ( $this->is_partial_capture( $notification ) ) {
$refund_object = $this->get_refund_object( $notification );
$amount = $refund_object->amount / 100;
if ( in_array( strtolower( $notification->data->object->currency ), WC_Stripe_Helper::no_decimal_currencies() ) ) {
$amount = $refund_object->amount;
}
return $amount;
}
return false;
}
/**
* Gets the amount we actually charge.
*
* @since 4.0.0
* @version 4.0.0
* @param object $notification
*/
public function get_partial_amount_to_charge( $notification ) {
if ( $this->is_partial_capture( $notification ) ) {
$amount = ( $notification->data->object->amount - $notification->data->object->amount_refunded ) / 100;
if ( in_array( strtolower( $notification->data->object->currency ), WC_Stripe_Helper::no_decimal_currencies() ) ) {
$amount = ( $notification->data->object->amount - $notification->data->object->amount_refunded );
}
return $amount;
}
return false;
}
/**
* Handles the processing of a payment intent webhook.
*
* @param stdClass $notification The webhook notification from Stripe.
*/
public function process_payment_intent( $notification ) {
$intent = $notification->data->object;
$order = $this->get_order_from_intent( $intent );
if ( ! $order ) {
WC_Stripe_Logger::log( 'Could not find order via intent ID: ' . $intent->id );
return;
}
if ( ! $order->has_status(
apply_filters(
'wc_stripe_allowed_payment_processing_statuses',
[ 'pending', 'failed' ],
$order
)
) ) {
return;
}
if ( $this->lock_order_payment( $order, $intent ) ) {
return;
}
$order_id = $order->get_id();
$payment_type_meta = $order->get_meta( '_stripe_upe_payment_type' );
$is_voucher_payment = in_array( $payment_type_meta, WC_Stripe_Payment_Methods::VOUCHER_PAYMENT_METHODS, true );
$is_wallet_payment = in_array( $payment_type_meta, WC_Stripe_Payment_Methods::WALLET_PAYMENT_METHODS, true );
switch ( $notification->type ) {
case 'payment_intent.requires_action':
do_action( 'wc_gateway_stripe_process_payment_intent_requires_action', $order, $notification->data->object );
if ( $is_voucher_payment ) {
$order->update_status( 'on-hold', __( 'Awaiting payment.', 'woocommerce-gateway-stripe' ) );
wc_reduce_stock_levels( $order_id );
}