class-wc-payment-gateway-wcpay.php
120 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
<?php
/**
* Class WC_Payment_Gateway_WCPay
*
* @package WooCommerce\Payments
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
use WCPay\Constants\Order_Status;
use WCPay\Constants\Payment_Capture_Type;
use WCPay\Constants\Payment_Initiated_By;
use WCPay\Constants\Payment_Intent_Status;
use WCPay\Constants\Payment_Type;
use WCPay\Constants\Payment_Method;
use WCPay\Exceptions\{ Add_Payment_Method_Exception, Amount_Too_Small_Exception, Process_Payment_Exception, Intent_Authentication_Exception, API_Exception };
use WCPay\Fraud_Prevention\Fraud_Prevention_Service;
use WCPay\Logger;
use WCPay\Payment_Information;
use WCPay\Payment_Methods\UPE_Payment_Gateway;
use WCPay\Payment_Methods\Link_Payment_Method;
use WCPay\Platform_Checkout\Platform_Checkout_Order_Status_Sync;
use WCPay\Platform_Checkout\Platform_Checkout_Utilities;
use WCPay\Session_Rate_Limiter;
use WCPay\Tracker;
/**
* Gateway class for WooCommerce Payments
*/
class WC_Payment_Gateway_WCPay extends WC_Payment_Gateway_CC {
use WC_Payment_Gateway_WCPay_Subscriptions_Trait;
/**
* Internal ID of the payment gateway.
*
* @type string
*/
const GATEWAY_ID = 'woocommerce_payments';
const METHOD_ENABLED_KEY = 'enabled';
const ACCOUNT_SETTINGS_MAPPING = [
'account_statement_descriptor' => 'statement_descriptor',
'account_business_name' => 'business_name',
'account_business_url' => 'business_url',
'account_business_support_address' => 'business_support_address',
'account_business_support_email' => 'business_support_email',
'account_business_support_phone' => 'business_support_phone',
'account_branding_logo' => 'branding_logo',
'account_branding_icon' => 'branding_icon',
'account_branding_primary_color' => 'branding_primary_color',
'account_branding_secondary_color' => 'branding_secondary_color',
'deposit_schedule_interval' => 'deposit_schedule_interval',
'deposit_schedule_weekly_anchor' => 'deposit_schedule_weekly_anchor',
'deposit_schedule_monthly_anchor' => 'deposit_schedule_monthly_anchor',
];
/**
* Stripe intents that are treated as successfully created.
*
* @type array
*/
const SUCCESSFUL_INTENT_STATUS = [
Payment_Intent_Status::SUCCEEDED,
Payment_Intent_Status::REQUIRES_CAPTURE,
Payment_Intent_Status::PROCESSING,
];
const UPDATE_SAVED_PAYMENT_METHOD = 'wcpay_update_saved_payment_method';
/**
* Set a large limit argument for retrieving user tokens.
*
* @type int
*/
const USER_FORMATTED_TOKENS_LIMIT = 100;
/**
* Key name for saving the current processing order_id to WC Session with the purpose
* of preventing duplicate payments in a single order.
*
* @type string
*/
const SESSION_KEY_PROCESSING_ORDER = 'wcpay_processing_order';
/**
* Flag to indicate that a previous order with the same cart content has already paid.
*
* @type string
*/
const FLAG_PREVIOUS_ORDER_PAID = 'wcpay_paid_for_previous_order';
/**
* Flag to indicate that a previous intention attached to the order was successful.
*/
const FLAG_PREVIOUS_SUCCESSFUL_INTENT = 'wcpay_previous_successful_intent';
/**
* Client for making requests to the WooCommerce Payments API
*
* @var WC_Payments_API_Client
*/
protected $payments_api_client;
/**
* WC_Payments_Account instance to get information about the account
*
* @var WC_Payments_Account
*/
protected $account;
/**
* WC_Payments_Customer instance for working with customer information
*
* @var WC_Payments_Customer_Service
*/
protected $customer_service;
/**
* WC_Payments_Token instance for working with customer tokens
*
* @var WC_Payments_Token_Service
*/
protected $token_service;
/**
* WC_Payments_Order_Service instance
*
* @var WC_Payments_Order_Service
*/
protected $order_service;
/**
* WC_Payments_Action_Scheduler_Service instance for scheduling ActionScheduler jobs.
*
* @var WC_Payments_Action_Scheduler_Service
*/
private $action_scheduler_service;
/**
* Session_Rate_Limiter instance for limiting failed transactions.
*
* @var Session_Rate_Limiter
*/
protected $failed_transaction_rate_limiter;
/**
* Mapping between capability keys and payment type keys
*
* @var array
*/
protected $payment_method_capability_key_map;
/**
* Platform checkout utilities.
*
* @var Platform_Checkout_Utilities
*/
protected $platform_checkout_util;
/**
* WC_Payment_Gateway_WCPay constructor.
*
* @param WC_Payments_API_Client $payments_api_client - WooCommerce Payments API client.
* @param WC_Payments_Account $account - Account class instance.
* @param WC_Payments_Customer_Service $customer_service - Customer class instance.
* @param WC_Payments_Token_Service $token_service - Token class instance.
* @param WC_Payments_Action_Scheduler_Service $action_scheduler_service - Action Scheduler service instance.
* @param Session_Rate_Limiter $failed_transaction_rate_limiter - Rate Limiter for failed transactions.
* @param WC_Payments_Order_Service $order_service - Order class instance.
*/
public function __construct(
WC_Payments_API_Client $payments_api_client,
WC_Payments_Account $account,
WC_Payments_Customer_Service $customer_service,
WC_Payments_Token_Service $token_service,
WC_Payments_Action_Scheduler_Service $action_scheduler_service,
Session_Rate_Limiter $failed_transaction_rate_limiter = null,
WC_Payments_Order_Service $order_service
) {
$this->payments_api_client = $payments_api_client;
$this->account = $account;
$this->customer_service = $customer_service;
$this->token_service = $token_service;
$this->action_scheduler_service = $action_scheduler_service;
$this->failed_transaction_rate_limiter = $failed_transaction_rate_limiter;
$this->order_service = $order_service;
$this->id = static::GATEWAY_ID;
$this->icon = ''; // TODO: icon.
$this->has_fields = true;
$this->method_title = __( 'WooCommerce Payments', 'woocommerce-payments' );
$this->method_description = WC_Payments_Utils::esc_interpolated_html(
/* translators: tosLink: Link to terms of service page, privacyLink: Link to privacy policy page */
__(
'WooCommerce Payments gives your store flexibility to accept credit cards, debit cards, and Apple Pay. Enable popular local payment methods and other digital wallets like Google Pay to give customers even more choice.<br/><br/>
By using WooCommerce Payments you agree to be bound by our <tosLink>Terms of Service</tosLink> and acknowledge that you have read our <privacyLink>Privacy Policy</privacyLink>',
'woocommerce-payments'
),
[
'br' => '<br/>',
'tosLink' => '<a href="https://wordpress.com/tos/" target="_blank" rel="noopener noreferrer">',
'privacyLink' => '<a href="https://automattic.com/privacy/" target="_blank" rel="noopener noreferrer">',
]
);
$this->title = __( 'Credit card / debit card', 'woocommerce-payments' );
$this->description = __( 'Enter your card details', 'woocommerce-payments' );
$this->supports = [
'products',
'refunds',
];
// Define setting fields.
$this->form_fields = [
'enabled' => [
'title' => __( 'Enable/disable', 'woocommerce-payments' ),
'label' => __( 'Enable WooCommerce Payments', 'woocommerce-payments' ),
'type' => 'checkbox',
'description' => '',
'default' => 'no',
],
'account_statement_descriptor' => [
'type' => 'account_statement_descriptor',
'title' => __( 'Customer bank statement', 'woocommerce-payments' ),
'description' => WC_Payments_Utils::esc_interpolated_html(
__( 'Edit the way your store name appears on your customers’ bank statements (read more about requirements <a>here</a>).', 'woocommerce-payments' ),
[ 'a' => '<a href="https://woocommerce.com/document/payments/bank-statement-descriptor/" target="_blank" rel="noopener noreferrer">' ]
),
],
'manual_capture' => [
'title' => __( 'Manual capture', 'woocommerce-payments' ),
'label' => __( 'Issue an authorization on checkout, and capture later.', 'woocommerce-payments' ),
'type' => 'checkbox',
'description' => __( 'Charge must be captured within 7 days of authorization, otherwise the authorization and order will be canceled.', 'woocommerce-payments' ),
'default' => 'no',
],
'saved_cards' => [
'title' => __( 'Saved cards', 'woocommerce-payments' ),
'label' => __( 'Enable payment via saved cards', 'woocommerce-payments' ),
'type' => 'checkbox',
'description' => __( 'If enabled, users will be able to pay with a saved card during checkout. Card details are saved on our platform, not on your store.', 'woocommerce-payments' ),
'default' => 'yes',
'desc_tip' => true,
],
'test_mode' => [
'title' => __( 'Test mode', 'woocommerce-payments' ),
'label' => __( 'Enable test mode', 'woocommerce-payments' ),
'type' => 'checkbox',
'description' => __( 'Simulate transactions using test card numbers.', 'woocommerce-payments' ),
'default' => 'no',
'desc_tip' => true,
],
'enable_logging' => [
'title' => __( 'Debug log', 'woocommerce-payments' ),
'label' => __( 'When enabled debug notes will be added to the log.', 'woocommerce-payments' ),
'type' => 'checkbox',
'description' => '',
'default' => 'no',
],
'payment_request_details' => [
'title' => __( 'Payment request buttons', 'woocommerce-payments' ),
'type' => 'title',
'description' => '',
],
'payment_request' => [
'title' => __( 'Enable/disable', 'woocommerce-payments' ),
'label' => sprintf(
/* translators: 1) br tag 2) Stripe anchor tag 3) Apple anchor tag */
__( 'Enable payment request buttons (Apple Pay, Google Pay, and more). %1$sBy using Apple Pay, you agree to %2$s and %3$s\'s Terms of Service.', 'woocommerce-payments' ),
'<br />',
'<a href="https://stripe.com/apple-pay/legal" target="_blank">Stripe</a>',
'<a href="https://developer.apple.com/apple-pay/acceptable-use-guidelines-for-websites/" target="_blank">Apple</a>'
),
'type' => 'checkbox',
'description' => __( 'If enabled, users will be able to pay using Apple Pay, Google Pay or the Payment Request API if supported by the browser.', 'woocommerce-payments' ),
'default' => empty( get_option( 'woocommerce_woocommerce_payments_settings' ) ) ? 'yes' : 'no', // Enable by default for new installations only.
'desc_tip' => true,
],
'payment_request_button_type' => [
'title' => __( 'Button type', 'woocommerce-payments' ),
'type' => 'select',
'description' => __( 'Select the button type you would like to show.', 'woocommerce-payments' ),
'default' => 'buy',
'desc_tip' => true,
'options' => [
'default' => __( 'Only icon', 'woocommerce-payments' ),
'buy' => __( 'Buy', 'woocommerce-payments' ),
'donate' => __( 'Donate', 'woocommerce-payments' ),
'book' => __( 'Book', 'woocommerce-payments' ),
],
],
'payment_request_button_theme' => [
'title' => __( 'Button theme', 'woocommerce-payments' ),
'type' => 'select',
'description' => __( 'Select the button theme you would like to show.', 'woocommerce-payments' ),
'default' => 'dark',
'desc_tip' => true,
'options' => [
'dark' => __( 'Dark', 'woocommerce-payments' ),
'light' => __( 'Light', 'woocommerce-payments' ),
'light-outline' => __( 'Light-Outline', 'woocommerce-payments' ),
],
],
'payment_request_button_height' => [
'title' => __( 'Button height', 'woocommerce-payments' ),
'type' => 'text',
'description' => __( 'Enter the height you would like the button to be in pixels. Width will always be 100%.', 'woocommerce-payments' ),
'default' => '44',
'desc_tip' => true,
],
'payment_request_button_label' => [
'title' => __( 'Custom button label', 'woocommerce-payments' ),
'type' => 'text',
'description' => __( 'Enter the custom text you would like the button to have.', 'woocommerce-payments' ),
'default' => __( 'Buy now', 'woocommerce-payments' ),
'desc_tip' => true,
],
'payment_request_button_locations' => [
'title' => __( 'Button locations', 'woocommerce-payments' ),
'type' => 'multiselect',
'description' => __( 'Select where you would like to display the button.', 'woocommerce-payments' ),
'default' => [
'product',
'cart',
'checkout',
],
'class' => 'wc-enhanced-select',
'desc_tip' => true,
'options' => [
'product' => __( 'Product', 'woocommerce-payments' ),
'cart' => __( 'Cart', 'woocommerce-payments' ),
'checkout' => __( 'Checkout', 'woocommerce-payments' ),
],
'custom_attributes' => [
'data-placeholder' => __( 'Select pages', 'woocommerce-payments' ),
],
],
'upe_enabled_payment_method_ids' => [
'title' => __( 'Payments accepted on checkout', 'woocommerce-payments' ),
'type' => 'multiselect',
'default' => [ 'card' ],
'options' => [],
],
'payment_request_button_size' => [
'title' => __( 'Size of the button displayed for Express Checkouts', 'woocommerce-payments' ),
'type' => 'select',
'description' => __( 'Select the size of the button.', 'woocommerce-payments' ),
'default' => 'default',
'desc_tip' => true,
'options' => [
'default' => __( 'Default', 'woocommerce-payments' ),
'medium' => __( 'Medium', 'woocommerce-payments' ),
'large' => __( 'Large', 'woocommerce-payments' ),
],
],
];
// Capabilities have different keys than the payment method ID's,
// so instead of appending '_payments' to the end of the ID, it'll be better
// to have a map for it instead, just in case the pattern changes.
$this->payment_method_capability_key_map = [
'sofort' => 'sofort_payments',
'giropay' => 'giropay_payments',
'bancontact' => 'bancontact_payments',
'eps' => 'eps_payments',
'ideal' => 'ideal_payments',
'p24' => 'p24_payments',
'card' => 'card_payments',
'sepa_debit' => 'sepa_debit_payments',
'au_becs_debit' => 'au_becs_debit_payments',
'link' => 'link_payments',
];
// Platform checkout utilities.
$this->platform_checkout_util = new Platform_Checkout_Utilities();
// Load the settings.
$this->init_settings();
// Check if subscriptions are enabled and add support for them.
$this->maybe_init_subscriptions();
// If the setting to enable saved cards is enabled, then we should support tokenization and adding payment methods.
if ( $this->is_saved_cards_enabled() ) {
array_push( $this->supports, 'tokenization', 'add_payment_method' );
}
add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, [ $this, 'process_admin_options' ] );
add_action( 'admin_notices', [ $this, 'display_errors' ], 9999 );
add_action( 'woocommerce_order_actions', [ $this, 'add_order_actions' ] );
add_action( 'woocommerce_order_action_capture_charge', [ $this, 'capture_charge' ] );
add_action( 'woocommerce_order_action_cancel_authorization', [ $this, 'cancel_authorization' ] );
add_action( 'wp_ajax_update_order_status', [ $this, 'update_order_status' ] );
add_action( 'wp_ajax_nopriv_update_order_status', [ $this, 'update_order_status' ] );
add_action( 'wp_enqueue_scripts', [ $this, 'register_scripts' ] );
add_action( 'wp_ajax_create_setup_intent', [ $this, 'create_setup_intent_ajax' ] );
add_action( 'wp_ajax_nopriv_create_setup_intent', [ $this, 'create_setup_intent_ajax' ] );
add_action( 'woocommerce_update_order', [ $this, 'schedule_order_tracking' ], 10, 2 );
// Update the current request logged_in cookie after a guest user is created to avoid nonce inconsistencies.
add_action( 'set_logged_in_cookie', [ $this, 'set_cookie_on_current_request' ] );
add_action( self::UPDATE_SAVED_PAYMENT_METHOD, [ $this, 'update_saved_payment_method' ], 10, 3 );
// Update the email field position.
add_filter( 'woocommerce_billing_fields', [ $this, 'checkout_update_email_field_priority' ], 50 );
// Priority 21 to run right after wc_clear_cart_after_payment.
add_action( 'template_redirect', [ $this, 'clear_session_processing_order_after_landing_order_received_page' ], 21 );
}
/**
* Proceed with current request using new login session (to ensure consistent nonce).
*
* @param string $cookie New cookie value.
*/
public function set_cookie_on_current_request( $cookie ) {
$_COOKIE[ LOGGED_IN_COOKIE ] = $cookie;
}
/**
* Check if the payment gateway is connected. This method is also used by
* external plugins to check if a connection has been established.
*/
public function is_connected() {
return $this->account->is_stripe_connected();
}
/**
* Returns true if the gateway needs additional configuration, false if it's ready to use.
*
* @see WC_Payment_Gateway::needs_setup
* @return bool
*/
public function needs_setup() {
if ( ! $this->is_connected() ) {
return true;
}
$account_status = $this->account->get_account_status_data();
return parent::needs_setup() || ! empty( $account_status['error'] ) || ! $account_status['paymentsEnabled'];
}
/**
* Check the defined constant to determine the current plugin mode.
*
* @return bool
*/
public function is_in_dev_mode() {
$is_extension_dev_mode = defined( 'WCPAY_DEV_MODE' ) && WCPAY_DEV_MODE;
$is_wordpress_dev_environment = function_exists( 'wp_get_environment_type' ) && in_array( wp_get_environment_type(), [ 'development', 'staging' ], true );
return apply_filters( 'wcpay_dev_mode', $is_extension_dev_mode || $is_wordpress_dev_environment );
}
/**
* Returns whether test_mode or dev_mode is active for the gateway
*
* @return boolean Test mode enabled if true, disabled if false
*/
public function is_in_test_mode() {
return apply_filters( 'wcpay_test_mode', $this->is_in_dev_mode() || 'yes' === $this->get_option( 'test_mode' ) );
}
/**
* Returns whether a store that is not in test mode needs to set https
* in the checkout
*
* @return boolean True if needs to set up forced ssl in checkout or https
*/
public function needs_https_setup() {
return ! $this->is_in_test_mode() && ! wc_checkout_is_https();
}
/**
* Checks if the gateway is enabled, and also if it's configured enough to accept payments from customers.
*
* Use parent method value alongside other business rules to make the decision.
*
* @return bool Whether the gateway is enabled and ready to accept payments.
*/
public function is_available() {
// Disable the gateway if using live mode without HTTPS set up or the currency is not
// available in the country of the account.
if ( $this->needs_https_setup() || ! $this->is_available_for_current_currency() ) {
return false;
}
return parent::is_available() && ! $this->needs_setup();
}
/**
* Checks if the setting to allow the user to save cards is enabled.
*
* @return bool Whether the setting to allow saved cards is enabled or not.
*/
public function is_saved_cards_enabled() {
return 'yes' === $this->get_option( 'saved_cards' );
}
/**
* Check if account is eligible for card present.
*
* @return bool
*/
public function is_card_present_eligible(): bool {
try {
return $this->account->is_card_present_eligible();
} catch ( Exception $e ) {
Logger::error( 'Failed to get account card present eligible. ' . $e );
return false;
}
}
/**
* Check if account is eligible for card testing protection.
*
* @return bool
*/
public function is_card_testing_protection_eligible(): bool {
try {
return $this->account->is_card_testing_protection_eligible();
} catch ( Exception $e ) {
Logger::error( 'Failed to get account card testing protection eligible. ' . $e );
return false;
}
}
/**
* Checks if the account country is compatible with the current currency.
*
* @return bool Whether the currency is supported in the country set in the account.
*/
public function is_available_for_current_currency() {
$supported_currencies = $this->account->get_account_customer_supported_currencies();
$current_currency = strtolower( get_woocommerce_currency() );
if ( count( $supported_currencies ) === 0 ) {
// If we don't have info related to the supported currencies
// of the country, we won't disable the gateway.
return true;
}
return in_array( $current_currency, $supported_currencies, true );
}
/**
* Admin Panel Options.
*/
public function admin_options() {
// Add notices to the WooCommerce Payments settings page.
do_action( 'woocommerce_woocommerce_payments_admin_notices' );
$this->output_payments_settings_screen();
}
/**
* Generates markup for the settings screen.
*/
public function output_payments_settings_screen() {
// hiding the save button because the react container has its own.
global $hide_save_button;
$hide_save_button = true;
if ( ! empty( $_GET['method'] ) ) : // phpcs:ignore WordPress.Security.NonceVerification.Recommended
?>
<div
id="wcpay-express-checkout-settings-container"
data-method-id="<?php echo esc_attr( sanitize_text_field( wp_unslash( $_GET['method'] ) ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended ?>"
></div>
<?php else : ?>
<div id="wcpay-account-settings-container"></div>
<?php
endif;
}
/**
* Registers all scripts, necessary for the gateway.
*/
public function register_scripts() {
// Register Stripe's JavaScript using the same ID as the Stripe Gateway plugin. This prevents this JS being
// loaded twice in the event a site has both plugins enabled. We still run the risk of different plugins
// loading different versions however. If Stripe release a v4 of their JavaScript, we could consider
// changing the ID to stripe_v4. This would allow older plugins to keep using v3 while we used any new
// feature in v4. Stripe have allowed loading of 2 different versions of stripe.js in the past (
// https://stripe.com/docs/stripe-js/elements/migrating).
wp_register_script(
'stripe',
'https://js.stripe.com/v3/',
[],
'3.0',
true
);
$script_dependencies = [ 'stripe', 'wc-checkout' ];
if ( $this->supports( 'tokenization' ) ) {
$script_dependencies[] = 'woocommerce-tokenization-form';
}
wp_register_script(
'WCPAY_CHECKOUT',
plugins_url( 'dist/checkout.js', WCPAY_PLUGIN_FILE ),
$script_dependencies,
WC_Payments::get_file_version( 'dist/checkout.js' ),
true
);
wp_set_script_translations( 'WCPAY_CHECKOUT', 'woocommerce-payments' );
}
/**
* Displays the save to account checkbox.
*
* @param bool $force_checked True if the checkbox must be forced to "checked" state (and invisible).
*/
public function save_payment_method_checkbox( $force_checked = false ) {
$id = 'wc-' . $this->id . '-new-payment-method';
$should_hide = $force_checked || $this->should_use_stripe_platform_on_checkout_page();
?>
<div <?php echo $should_hide ? 'style="display:none;"' : ''; /* phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped */ ?>>
<p class="form-row woocommerce-SavedPaymentMethods-saveNew">
<input id="<?php echo esc_attr( $id ); ?>" name="<?php echo esc_attr( $id ); ?>" type="checkbox" value="true" style="width:auto;" <?php echo $force_checked ? 'checked' : ''; /* phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped */ ?> />
<label for="<?php echo esc_attr( $id ); ?>" style="display:inline;">
<?php echo esc_html( apply_filters( 'wc_payments_save_to_account_text', __( 'Save payment information to my account for future purchases.', 'woocommerce-payments' ) ) ); ?>
</label>
</p>
</div>
<?php
}
/**
* Whether we should use the platform account to initialize Stripe on the checkout page.
*
* @return bool
*/
public function should_use_stripe_platform_on_checkout_page() {
if (
WC_Payments_Features::is_platform_checkout_eligible() &&
'yes' === $this->get_option( 'platform_checkout', 'no' ) &&
! WC_Payments_Features::is_upe_enabled() &&
( is_checkout() || has_block( 'woocommerce/checkout' ) ) &&
! is_wc_endpoint_url( 'order-pay' ) &&
! WC()->cart->is_empty() &&
WC()->cart->needs_payment()
) {
return true;
}
return false;
}
/**
* Renders the credit card input fields needed to get the user's payment information on the checkout page.
*
* We also add the JavaScript which drives the UI.
*/
public function payment_fields() {
do_action( 'wc_payments_add_payment_fields' );
}
/**
* Process the payment for a given order.
*
* @param int $order_id Order ID to process the payment for.
*
* @return array|null An array with result of payment and redirect URL, or nothing.
* @throws Process_Payment_Exception Error processing the payment.
* @throws Exception Error processing the payment.
*/
public function process_payment( $order_id ) {
$order = wc_get_order( $order_id );
try {
// Check if session exists before instantiating Fraud_Prevention_Service.
if ( WC()->session ) {
$fraud_prevention_service = Fraud_Prevention_Service::get_instance();
// phpcs:ignore WordPress.Security.NonceVerification.Missing,WordPress.Security.ValidatedSanitizedInput.MissingUnslash,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
if ( $fraud_prevention_service->is_enabled() && ! $fraud_prevention_service->verify_token( $_POST['wcpay-fraud-prevention-token'] ?? null ) ) {
throw new Process_Payment_Exception(
__( "We're not able to process this payment. Please refresh the page and try again.", 'woocommerce-payments' ),
'fraud_prevention_enabled'
);
}
}
if ( $this->failed_transaction_rate_limiter->is_limited() ) {
throw new Process_Payment_Exception(
__( 'Your payment was not processed.', 'woocommerce-payments' ),
'rate_limiter_enabled'
);
}
// The request is a preflight check from WooPay.
// phpcs:ignore WordPress.Security.NonceVerification.Missing
if ( ! empty( $_POST['is-woopay-preflight-check'] ) ) {
// Set the order status to "pending payment".
$order->update_status( 'pending' );
// Bail out with success so we don't process the payment now,
// but still let WooPay continue with the payment processing.
return [
'result' => 'success',
'redirect' => '',
];
}
UPE_Payment_Gateway::remove_upe_payment_intent_from_session();
$check_session_order = $this->check_against_session_processing_order( $order );
if ( is_array( $check_session_order ) ) {
return $check_session_order;
}
$this->maybe_update_session_processing_order( $order_id );
$check_existing_intention = $this->check_payment_intent_attached_to_order_succeeded( $order );
if ( is_array( $check_existing_intention ) ) {
return $check_existing_intention;
}
$payment_information = $this->prepare_payment_information( $order );
return $this->process_payment_for_order( WC()->cart, $payment_information );
} catch ( Exception $e ) {
/**
* TODO: Determine how to do this update with Order_Service.
* It seems that the status only needs to change in certain instances, and within those instances the intent
* information is not added to the order, as shown by tests.
*/
if ( empty( $payment_information ) || ! $payment_information->is_changing_payment_method_for_subscription() ) {
$order->update_status( Order_Status::FAILED );
}
if ( $e instanceof API_Exception && $this->should_bump_rate_limiter( $e->get_error_code() ) ) {
$this->failed_transaction_rate_limiter->bump();
}
if ( ! empty( $payment_information ) ) {
/* translators: %1: the failed payment amount, %2: error message */
$error_message = __(
'A payment of %1$s <strong>failed</strong> to complete with the following message: <code>%2$s</code>.',
'woocommerce-payments'
);
$error_details = esc_html( rtrim( $e->getMessage(), '.' ) );
if ( $e instanceof API_Exception && 'card_error' === $e->get_error_type() && 'incorrect_zip' === $e->get_error_code() ) {
/* translators: %1: the failed payment amount, %2: error message */
$error_message = __(
'A payment of %1$s <strong>failed</strong>. %2$s',
'woocommerce-payments'
);
$error_details = __(
'We couldn’t verify the postal code in the billing address. If the issue persists, suggest the customer to reach out to the card issuing bank.',
'woocommerce-payments'
);
}
$note = sprintf(
WC_Payments_Utils::esc_interpolated_html(
$error_message,
[
'strong' => '<strong>',
'code' => '<code>',
]
),
WC_Payments_Explicit_Price_Formatter::get_explicit_price( wc_price( $order->get_total(), [ 'currency' => $order->get_currency() ] ), $order ),
$error_details
);
$order->add_order_note( $note );
}
if ( $e instanceof Process_Payment_Exception && 'rate_limiter_enabled' === $e->get_error_code() ) {
$note = sprintf(
WC_Payments_Utils::esc_interpolated_html(
/* translators: %1: the failed payment amount */
__(
'A payment of %1$s <strong>failed</strong> to complete because of too many failed transactions. A rate limiter was enabled for the user to prevent more attempts temporarily.',
'woocommerce-payments'
),
[
'strong' => '<strong>',
]
),
WC_Payments_Explicit_Price_Formatter::get_explicit_price( wc_price( $order->get_total(), [ 'currency' => $order->get_currency() ] ), $order )
);
$order->add_order_note( $note );
}
UPE_Payment_Gateway::remove_upe_payment_intent_from_session();
// Re-throw the exception after setting everything up.
// This makes the error notice show up both in the regular and block checkout.
throw new Exception( WC_Payments_Utils::get_filtered_error_message( $e ) );
}
}
/**
* Prepares the payment information object.
*
* @param WC_Order $order The order whose payment will be processed.
* @return Payment_Information An object, which describes the payment.
*/
protected function prepare_payment_information( $order ) {
// phpcs:ignore WordPress.Security.NonceVerification.Missing
$payment_information = Payment_Information::from_payment_request( $_POST, $order, Payment_Type::SINGLE(), Payment_Initiated_By::CUSTOMER(), $this->get_capture_type() );
$payment_information = $this->maybe_prepare_subscription_payment_information( $payment_information, $order->get_id() );
if ( ! empty( $_POST[ 'wc-' . static::GATEWAY_ID . '-new-payment-method' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
// During normal orders the payment method is saved when the customer enters a new one and chooses to save it.
$payment_information->must_save_payment_method_to_store();
}
if ( $this->platform_checkout_util->should_save_platform_customer() ) {
do_action( 'woocommerce_payments_save_user_in_platform_checkout' );
$payment_information->must_save_payment_method_to_platform();
}
return $payment_information;
}
/**
* Update the customer details with the incoming order data, in a CRON job.
*
* @param \WC_Order $order WC order id.
* @param string $customer_id The customer id to update details for.
* @param bool $is_test_mode Whether to run the CRON job in test mode.
* @param bool $is_woopay Whether CRON job was queued from WooPay.
*/
public function update_customer_with_order_data( $order, $customer_id, $is_test_mode = false, $is_woopay = false ) {
// Since this CRON job may have been created in test_mode, when the CRON job runs, it
// may lose the test_mode context. So, instead, we pass that context when creating
// the CRON job and apply the context here.
$apply_test_mode_context = function () use ( $is_test_mode ) {
return $is_test_mode;
};
add_filter( 'wcpay_test_mode', $apply_test_mode_context );
$user = $order->get_user();
if ( false === $user ) {
$user = wp_get_current_user();
}
// Since this function will run in a CRON job, "wp_get_current_user()" will default
// to user with ID of 0. So, instead, we replace it with the user from the $order,
// when updating a WooPay user.
$apply_order_user_email = function ( $params ) use ( $user, $is_woopay ) {
if ( $is_woopay ) {
$params['email'] = $user->user_email;
}
return $params;
};
add_filter( 'wcpay_api_request_params', $apply_order_user_email, 20, 1 );
// Update the existing customer with the current order details.
$customer_data = WC_Payments_Customer_Service::map_customer_data( $order, new WC_Customer( $user->ID ) );
$this->customer_service->update_customer_for_user( $customer_id, $user, $customer_data );
}
/**
* Manages customer details held on WCPay server for WordPress user associated with an order.
*
* @param WC_Order $order WC Order object.
* @param array $options Additional options to apply.
*
* @return array First element is the new or updated WordPress user, the second element is the WCPay customer ID.
*/
protected function manage_customer_details_for_order( $order, $options = [] ) {
$user = $order->get_user();
if ( false === $user ) {
$user = wp_get_current_user();
}
// Determine the customer making the payment, create one if we don't have one already.
$customer_id = $this->customer_service->get_customer_id_by_user_id( $user->ID );
if ( null === $customer_id ) {
$customer_data = WC_Payments_Customer_Service::map_customer_data( $order, new WC_Customer( $user->ID ) );
// Create a new customer.
$customer_id = $this->customer_service->create_customer_for_user( $user, $customer_data );
} else {
// Update the customer with order data async.
$this->update_customer_with_order_data( $order, $customer_id, $this->is_in_test_mode(), $options['is_woopay'] ?? false );
}
return [ $user, $customer_id ];
}
/**
* Update the saved payment method information with checkout values, in a CRON job.
*
* @param string $payment_method The payment method to update.
* @param int $order_id WC order id.
* @param bool $is_test_mode Whether to run the CRON job in test mode.
*/
public function update_saved_payment_method( $payment_method, $order_id, $is_test_mode = false ) {
// Since this CRON job may have been created in test_mode, when the CRON job runs, it
// may lose the test_mode context. So, instead, we pass that context when creating
// the CRON job and apply the context here.
$apply_test_mode_context = function () use ( $is_test_mode ) {
return $is_test_mode;
};
add_filter( 'wcpay_test_mode', $apply_test_mode_context );
$order = wc_get_order( $order_id );
try {
$this->customer_service->update_payment_method_with_billing_details_from_order( $payment_method, $order );
} catch ( Exception $e ) {
// If updating the payment method fails, log the error message.
Logger::log( 'Error when updating saved payment method: ' . $e->getMessage() );
}
}
/**
* Process the payment for a given order.
*
* @param WC_Cart|null $cart Cart.
* @param WCPay\Payment_Information $payment_information Payment info.
* @param array $additional_api_parameters Any additional fields required for payment method to pass to API.
*
* @return array|null An array with result of payment and redirect URL, or nothing.
* @throws API_Exception Error processing the payment.
* @throws Add_Payment_Method_Exception When $0 order processing failed.
* @throws Intent_Authentication_Exception When the payment intent could not be authenticated.
*/
public function process_payment_for_order( $cart, $payment_information, $additional_api_parameters = [] ) {
$order = $payment_information->get_order();
$save_payment_method_to_store = $payment_information->should_save_payment_method_to_store();
$is_changing_payment_method_for_subscription = $payment_information->is_changing_payment_method_for_subscription();
$order_id = $order->get_id();
$amount = $order->get_total();
$metadata = $this->get_metadata_from_order( $order, $payment_information->get_payment_type() );
$customer_details_options = [
'is_woopay' => filter_var( $metadata['paid_on_woopay'] ?? false, FILTER_VALIDATE_BOOLEAN ),
];
list( $user, $customer_id ) = $this->manage_customer_details_for_order( $order, $customer_details_options );
// Update saved payment method async to include billing details, if missing.
if ( $payment_information->is_using_saved_payment_method() ) {
$this->action_scheduler_service->schedule_job(
time(),
self::UPDATE_SAVED_PAYMENT_METHOD,
[
'payment_method' => $payment_information->get_payment_method(),
'order_id' => $order->get_id(),
'is_test_mode' => $this->is_in_test_mode(),
]
);
}
$intent_failed = false;
$payment_needed = $amount > 0;
// Make sure that we attach the payment method and the customer ID to the order meta data.
$payment_method = $payment_information->get_payment_method();
$order->update_meta_data( '_payment_method_id', $payment_method );
$order->update_meta_data( '_stripe_customer_id', $customer_id );
$order->update_meta_data( '_wcpay_mode', $this->is_in_test_mode() ? 'test' : 'prod' );
// In case amount is 0 and we're not saving the payment method, we won't be using intents and can confirm the order payment.
if ( apply_filters( 'wcpay_confirm_without_payment_intent', ! $payment_needed && ! $save_payment_method_to_store ) ) {
$order->payment_complete();
if ( $payment_information->is_using_saved_payment_method() ) {
// We need to make sure the saved payment method is saved to the order so we can
// charge the payment method for a future payment.
$this->add_token_to_order( $order, $payment_information->get_payment_token() );
}
if ( $is_changing_payment_method_for_subscription && $payment_information->is_using_saved_payment_method() ) {
$payment_token = $payment_information->get_payment_token();
$note = sprintf(
WC_Payments_Utils::esc_interpolated_html(
/* translators: %1: the last 4 digit of the credit card */
__( 'Payment method is changed to: <strong>Credit card ending in %1$s</strong>.', 'woocommerce-payments' ),
[
'strong' => '<strong>',
]
),
$payment_token instanceof WC_Payment_Token_CC ? $payment_token->get_last4() : '----'
);
$order->add_order_note( $note );
do_action( 'woocommerce_payments_changed_subscription_payment_method', $order, $payment_token );
}
$order->set_payment_method_title( __( 'Credit / Debit Card', 'woocommerce-payments' ) );
$order->save();
return [
'result' => 'success',
'redirect' => $this->get_return_url( $order ),
];
}
// Add card mandate options parameters to the order payment intent if needed.
$additional_api_parameters = array_merge(
$additional_api_parameters,
$this->get_mandate_params_for_order( $order )
);
if ( $payment_needed ) {
$converted_amount = WC_Payments_Utils::prepare_amount( $amount, $order->get_currency() );
$currency = strtolower( $order->get_currency() );
// Try catching the error without reaching the API.
$minimum_amount = WC_Payments_Utils::get_cached_minimum_amount( $currency );
if ( $minimum_amount > $converted_amount ) {
$e = new Amount_Too_Small_Exception( 'Amount too small', $minimum_amount, $currency, 400 );
throw new Exception( WC_Payments_Utils::get_filtered_error_message( $e ) );
}
$payment_methods = WC_Payments::get_gateway()->get_payment_method_ids_enabled_at_checkout( null, true );
$additional_api_parameters['is_platform_payment_method'] = $this->is_platform_payment_method( $payment_information->is_using_saved_payment_method() );
// This meta is only set by WooPay.
// We want to handle the intention creation differently when there are subscriptions.
// We're using simple products on WooPay so the current logic for WCPay subscriptions won't work there.
if ( '1' === $order->get_meta( '_woopay_has_subscription' ) ) {
$additional_api_parameters['woopay_has_subscription'] = 'true';
}
// The sanitize_user call here is deliberate: it seems the most appropriate sanitization function
// for a string that will only contain latin alphanumeric characters and underscores.
// phpcs:ignore WordPress.Security.NonceVerification.Missing
$platform_checkout_intent_id = sanitize_user( wp_unslash( $_POST['platform-checkout-intent'] ?? '' ), true );
// Initializing the intent variable here to ensure we don't try to use an undeclared
// variable later.
$intent = null;
if ( ! empty( $platform_checkout_intent_id ) ) {
// If the intent is included in the request use that intent.
$intent = $this->payments_api_client->get_intent( $platform_checkout_intent_id );
$intent_meta_order_id_raw = $intent->get_metadata()['order_id'] ?? '';
$intent_meta_order_id = is_numeric( $intent_meta_order_id_raw ) ? intval( $intent_meta_order_id_raw ) : 0;
if ( $intent_meta_order_id !== $order_id ) {
throw new Intent_Authentication_Exception(
__( "We're not able to process this payment. Please try again later.", 'woocommerce-payments' ),
'order_id_mismatch'
);
}
}
if ( empty( $intent ) ) {
// Create intention, try to confirm it & capture the charge (if 3DS is not required).
$intent = $this->payments_api_client->create_and_confirm_intention(
$converted_amount,
$currency,
$payment_information->get_payment_method(),
$customer_id,
$payment_information->is_using_manual_capture(),
$save_payment_method_to_store,
$payment_information->should_save_payment_method_to_platform(),
$metadata,
$this->get_level3_data_from_order( $order ),
$payment_information->is_merchant_initiated(),
$additional_api_parameters,
$payment_methods,
$payment_information->get_cvc_confirmation(),
$payment_information->get_fingerprint()
);
}
$intent_id = $intent->get_id();
$status = $intent->get_status();
$charge = $intent->get_charge();
$charge_id = $charge ? $charge->get_id() : null;
$client_secret = $intent->get_client_secret();
$currency = $intent->get_currency();
$next_action = $intent->get_next_action();
$processing = $intent->get_processing();
// We update the payment method ID server side when it's necessary to clone payment methods,
// for example when saving a payment method to a platform customer account. When this happens
// we need to make sure the payment method on the order matches the one on the merchant account
// not the one on the platform account. The payment method ID is updated on the order further
// down.
$payment_method = $intent->get_payment_method_id() ?? $payment_method;
if ( Payment_Intent_Status::REQUIRES_ACTION === $status && $payment_information->is_merchant_initiated() ) {
// Allow 3rd-party to trigger some action if needed.
do_action( 'woocommerce_woocommerce_payments_payment_requires_action', $order, $intent_id, $payment_method, $customer_id, $charge_id, $currency );
$this->order_service->mark_payment_failed( $order, $intent_id, $status, $charge_id );
}
} else {
// phpcs:ignore WordPress.Security.NonceVerification.Missing
$platform_checkout_intent_id = sanitize_user( wp_unslash( $_POST['platform-checkout-intent'] ?? '' ), true );
if ( ! empty( $platform_checkout_intent_id ) ) {
// If the setup intent is included in the request use that intent.
$intent = $this->payments_api_client->get_setup_intent( $platform_checkout_intent_id );
$intent_meta_order_id_raw = ! empty( $intent['metadata'] ) ? $intent['metadata']['order_id'] ?? '' : '';
$intent_meta_order_id = is_numeric( $intent_meta_order_id_raw ) ? intval( $intent_meta_order_id_raw ) : 0;
if ( $intent_meta_order_id !== $order_id ) {
throw new Intent_Authentication_Exception(
__( "We're not able to process this payment. Please try again later.", 'woocommerce-payments' ),
'order_id_mismatch'
);
}
} else {
$save_user_in_platform_checkout = false;
if ( $this->platform_checkout_util->should_save_platform_customer() ) {
$save_user_in_platform_checkout = true;
$metadata_from_order = apply_filters(
'wcpay_metadata_from_order',
[
'customer_email' => $order->get_billing_email(),
],
$order
);
$metadata = array_merge( (array) $metadata_from_order, (array) $metadata ); // prioritize metadata from mobile app.
do_action( 'woocommerce_payments_save_user_in_platform_checkout' );
}
// For $0 orders, we need to save the payment method using a setup intent.
$intent = $this->payments_api_client->create_and_confirm_setup_intent(
$payment_information->get_payment_method(),
$customer_id,
false,
$this->is_platform_payment_method( $payment_information->is_using_saved_payment_method() ),
$save_user_in_platform_checkout,
$metadata
);
}
$intent_id = $intent['id'];
$status = $intent['status'];
$charge_id = '';
$client_secret = $intent['client_secret'];
$currency = $order->get_currency();
$next_action = $intent['next_action'];
$processing = [];
}
if ( ! empty( $intent ) ) {
if ( ! in_array( $status, self::SUCCESSFUL_INTENT_STATUS, true ) ) {
$intent_failed = true;
}
if ( $save_payment_method_to_store && ! $intent_failed ) {
try {
$token = null;
// Setup intents are currently not deserialized as payment intents are, so check if it's an array first.
// For WooPay checkouts, we may provide a platform payment method from `$payment_information`, but we need
// to return a connected payment method. So we should always retrieve the payment method from the intent.
$payment_method_id = is_array( $intent ) ? $intent['payment_method'] : $intent->get_payment_method_id();
// Handle orders that are paid via WooPay and contain subscriptions.
if ( $order->get_meta( 'is_woopay' ) && function_exists( 'wcs_order_contains_subscription' ) && wcs_order_contains_subscription( $order ) ) {
$customer_tokens = WC_Payment_Tokens::get_customer_tokens( $order->get_user_id(), self::GATEWAY_ID );
// Use the existing token if we already have one for the incoming payment method.
foreach ( $customer_tokens as $saved_token ) {
if ( $saved_token->get_token() === $payment_method_id ) {
$token = $saved_token;
break;
}
}
}
// Store a new token if we're not paying for a subscription in WooPay,
// or if we are, but we didn't find a stored token for the selected payment method.
if ( empty( $token ) ) {
$token = $this->token_service->add_payment_method_to_user( $payment_method_id, $user );
}
$payment_information->set_token( $token );
} catch ( Exception $e ) {
// If saving the token fails, log the error message but catch the error to avoid crashing the checkout flow.
Logger::log( 'Error when saving payment method: ' . $e->getMessage() );
}
}
if ( $payment_information->is_using_saved_payment_method() ) {
$token = $payment_information->get_payment_token();
$this->add_token_to_order( $order, $token );
if ( $order->get_meta( '_woopay_has_subscription' ) ) {
$token->update_meta_data( 'is_attached_to_subscription', '1' );
$token->save_meta_data();
}
}
if ( Payment_Intent_Status::REQUIRES_ACTION === $status ) {
if ( isset( $next_action['type'] ) && 'redirect_to_url' === $next_action['type'] && ! empty( $next_action['redirect_to_url']['url'] ) ) {
$response = [
'result' => 'success',
'redirect' => $next_action['redirect_to_url']['url'],
];
} else {
$response = [
'result' => 'success',
// Include a new nonce for update_order_status to ensure the update order
// status call works when a guest user creates an account during checkout.
'redirect' => sprintf(
'#wcpay-confirm-%s:%s:%s:%s',
$payment_needed ? 'pi' : 'si',
$order_id,
WC_Payments_Utils::encrypt_client_secret( $this->account->get_stripe_account_id(), $client_secret ),
wp_create_nonce( 'wcpay_update_order_status_nonce' )
),
// Include the payment method ID so the Blocks integration can save cards.
'payment_method' => $payment_information->get_payment_method(),
];
}
}
}
$this->attach_intent_info_to_order( $order, $intent_id, $status, $payment_method, $customer_id, $charge_id, $currency );
$this->attach_exchange_info_to_order( $order, $charge_id );
$this->update_order_status_from_intent( $order, $intent_id, $status, $charge_id );
$this->maybe_add_customer_notification_note( $order, $processing );
if ( isset( $response ) ) {
return $response;
}
wc_reduce_stock_levels( $order_id );
if ( isset( $cart ) ) {
$cart->empty_cart();
}
if ( $payment_needed ) {
$charge = $intent ? $intent->get_charge() : null;
$payment_method_details = $charge ? $charge->get_payment_method_details() : [];
$payment_method_type = $payment_method_details ? $payment_method_details['type'] : null;
if ( $order->get_meta( 'is_woopay' ) && 'card' === $payment_method_type && isset( $payment_method_details['card']['last4'] ) ) {
$order->add_meta_data( 'last4', $payment_method_details['card']['last4'], true );
$order->save_meta_data();
}
} else {
$payment_method_details = false;
$payment_method_options = isset( $intent['payment_method_options'] ) ? array_keys( $intent['payment_method_options'] ) : null;
$payment_method_type = $payment_method_options ? $payment_method_options[0] : null;
}
if ( empty( $_POST['payment_request_type'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
$this->set_payment_method_title_for_order( $order, $payment_method_type, $payment_method_details );
}
return [
'result' => 'success',
'redirect' => $this->get_return_url( $order ),
];
}
/**
* By default this function does not do anything. But it can be overriden by child classes.
* It is used to set a formatted readable payment method title for order,
* using payment method details from accompanying charge.
*
* @param WC_Order $order WC Order being processed.
* @param string $payment_method_type Stripe payment method key.
* @param array|bool $payment_method_details Array of payment method details from charge or false.
*/
public function set_payment_method_title_for_order( $order, $payment_method_type, $payment_method_details ) {
}
/**
* Prepares Stripe metadata for a given order. The metadata later injected into intents, and
* used in transactions listing/details. If merchant connects an account to new store, listing/details
* keeps working even if orders are not available anymore - the metadata provides needed details.
*
* @param WC_Order $order Order being processed.
* @param Payment_Type $payment_type Enum stating whether payment is single or recurring.
*
* @return array Array of keyed metadata values.
*/
protected function get_metadata_from_order( $order, $payment_type ) {
$name = sanitize_text_field( $order->get_billing_first_name() ) . ' ' . sanitize_text_field( $order->get_billing_last_name() );
$email = sanitize_email( $order->get_billing_email() );
$metadata = [
'customer_name' => $name,
'customer_email' => $email,
'site_url' => esc_url( get_site_url() ),
'order_id' => $order->get_id(),
'order_number' => $order->get_order_number(),
'order_key' => $order->get_order_key(),
'payment_type' => $payment_type,
];
// If the order belongs to a WCPay Subscription, set the payment context to 'wcpay_subscription' (this helps with associating which fees belong to orders).
if ( 'recurring' === (string) $payment_type && ! $this->is_subscriptions_plugin_active() ) {
$subscriptions = wcs_get_subscriptions_for_order( $order, [ 'order_type' => 'any' ] );
foreach ( $subscriptions as $subscription ) {
if ( WC_Payments_Subscription_Service::is_wcpay_subscription( $subscription ) ) {
$metadata['payment_context'] = 'wcpay_subscription';
break;
}
}
}
return apply_filters( 'wcpay_metadata_from_order', $metadata, $order, $payment_type );
}
/**
* Given the charge data, checks if there was an exchange and adds it to the given order as metadata
*
* @param WC_Order $order The order to update.
* @param string $charge_id ID of the charge to attach data from.
*/
public function attach_exchange_info_to_order( $order, $charge_id ) {
if ( empty( $charge_id ) ) {
return;
}
$currency_store = strtolower( get_option( 'woocommerce_currency' ) );
$currency_order = strtolower( $order->get_currency() );
$currency_account = strtolower( $this->account->get_account_default_currency() );
// If the default currency for the store is different from the currency for the merchant's Stripe account,
// the conversion rate provided by Stripe won't make sense, so we should not attach it to the order meta data
// and instead we'll rely on the _wcpay_multi_currency_order_exchange_rate meta key for analytics.
if ( $currency_store !== $currency_account ) {
return;
}
if ( $currency_order !== $currency_account ) {
// We check that the currency used in the order is different than the one set in the WC Payments account
// to avoid requesting the charge if not needed.
$charge = $this->payments_api_client->get_charge( $charge_id );
$exchange_rate = $charge['balance_transaction']['exchange_rate'] ?? null;
if ( isset( $exchange_rate ) ) {
$exchange_rate = WC_Payments_Utils::interpret_string_exchange_rate( $exchange_rate, $currency_order, $currency_account );
$order->update_meta_data( '_wcpay_multi_currency_stripe_exchange_rate', $exchange_rate );
$order->save_meta_data();
}
}
}
/**
* Given the payment intent data, adds it to the given order as metadata and parses any notes that need to be added
*
* @param WC_Order $order The order to update.
* @param string $intent_id The intent ID.
* @param string $intent_status Intent status.
* @param string $payment_method Payment method ID.
* @param string $customer_id Customer ID.
* @param string $charge_id Charge ID.
* @param string $currency Currency code.
*/
public function attach_intent_info_to_order( $order, $intent_id, $intent_status, $payment_method, $customer_id, $charge_id, $currency ) {
// first, let's save all the metadata that needed for refunds, required for status change etc.
$order->set_transaction_id( $intent_id );
$order->update_meta_data( '_intent_id', $intent_id );
$order->update_meta_data( '_charge_id', $charge_id );
$order->update_meta_data( '_intention_status', $intent_status );
$order->update_meta_data( '_payment_method_id', $payment_method );
$order->update_meta_data( '_stripe_customer_id', $customer_id );
WC_Payments_Utils::set_order_intent_currency( $order, $currency );
$order->save();
}
/**
* Parse the payment intent data and add any necessary notes to the order and update the order status accordingly.
*
* @param WC_Order $order The order to update.
* @param string $intent_id The intent ID.
* @param string $intent_status Intent status.
* @param string $charge_id Charge ID.
*/
public function update_order_status_from_intent( $order, $intent_id, $intent_status, $charge_id ) {
switch ( $intent_status ) {
case Payment_Intent_Status::SUCCEEDED:
$this->remove_session_processing_order( $order->get_id() );
$this->order_service->mark_payment_completed( $order, $intent_id, $intent_status, $charge_id );
break;
case Payment_Intent_Status::PROCESSING:
case Payment_Intent_Status::REQUIRES_CAPTURE:
$this->order_service->mark_payment_authorized( $order, $intent_id, $intent_status, $charge_id );
break;
case Payment_Intent_Status::REQUIRES_ACTION:
case Payment_Intent_Status::REQUIRES_PAYMENT_METHOD:
$this->order_service->mark_payment_started( $order, $intent_id, $intent_status, $charge_id );
break;
default:
Logger::error( 'Uncaught payment intent status of ' . $intent_status . ' passed for order id: ' . $order->get_id() );
break;
}
}
/**
* Saves the payment token to the order.
*
* @param WC_Order $order The order.
* @param WC_Payment_Token $token The token to save.
*/
public function add_token_to_order( $order, $token ) {
$payment_token = $this->get_payment_token( $order );
// This could lead to tokens being saved twice in an order's payment tokens, but it is needed so that shoppers
// may re-use a previous card for the same subscription, as we consider the last token to be the active one.
// We can't remove the previous entry for the token because WC_Order does not support removal of tokens [1] and
// we can't delete the token as it might be used somewhere else.
// [1] https://github.com/woocommerce/woocommerce/issues/11857.
if ( is_null( $payment_token ) || $token->get_id() !== $payment_token->get_id() ) {
$order->add_payment_token( $token );
}
$this->maybe_add_token_to_subscription_order( $order, $token );
}
/**
* Retrieve payment token from a subscription or order.
*
* @param WC_Order $order Order or subscription object.
*
* @return null|WC_Payment_Token Last token associated with order or subscription.
*/
protected function get_payment_token( $order ) {
$order_tokens = $order->get_payment_tokens();
$token_id = end( $order_tokens );
return ! $token_id ? null : WC_Payment_Tokens::get( $token_id );
}
/**
* Can the order be refunded?
*
* @param WC_Order $order Order object.
* @return bool
*/
public function can_refund_order( $order ) {
return $order && $order->get_meta( '_charge_id', true );
}
/**
* Refund a charge.
*
* @param int $order_id - the Order ID to process the refund for.
* @param float $amount - the amount to refund.
* @param string $reason - the reason for refunding.
*
* @return bool|WP_Error - Whether the refund went through. Returns a WP_Error if an Exception occurs during execution.
*/
public function process_refund( $order_id, $amount = null, $reason = '' ) {
$order = wc_get_order( $order_id );
$currency = WC_Payments_Utils::get_order_intent_currency( $order );
if ( ! $order ) {
return false;
}
// If this order is not captured yet, don't try and refund it. Instead, return an appropriate error message.
if ( Payment_Intent_Status::REQUIRES_CAPTURE === $order->get_meta( '_intention_status', true ) ) {
return new WP_Error(
'uncaptured-payment',
/* translators: an error message which will appear if a user tries to refund an order which is has been authorized but not yet charged. */
__( "This payment is not captured yet. To cancel this order, please go to 'Order Actions' > 'Cancel authorization'. To proceed with a refund, please go to 'Order Actions' > 'Capture charge' to charge the payment card, and then trigger a refund via the 'Refund' button.", 'woocommerce-payments' )
);
}
// If the entered amount is not valid stop without making a request.
if ( $amount <= 0 || $amount > $order->get_total() ) {
return new WP_Error(
'invalid-amount',
__( 'The refund amount is not valid.', 'woocommerce-payments' )
);
}
$charge_id = $order->get_meta( '_charge_id', true );
try {
// If the payment method is Interac, the refund already exists (refunded via Mobile app).
$is_refunded_off_session = Payment_Method::INTERAC_PRESENT === $this->get_payment_method_type_for_order( $order );
if ( $is_refunded_off_session ) {
$refund_amount = WC_Payments_Utils::prepare_amount( $amount ?? $order->get_total(), $order->get_currency() );
$refunds = array_filter(
$this->payments_api_client->list_refunds( $charge_id )['data'],
static function ( $refund ) use ( $refund_amount ) {
return 'succeeded' === $refund['status'] && $refund_amount === $refund['amount'];
}
);
if ( [] === $refunds ) {
return new WP_Error(
'wcpay_edit_order_refund_not_possible',
__( 'You shall refund this payment in the same application where the payment was made.', 'woocommerce-payments' )
);
}
$refund = array_pop( $refunds );
} else {
if ( null === $amount ) {
// If amount is null, the default is the entire charge.
$refund = $this->payments_api_client->refund_charge( $charge_id );
} else {
$refund = $this->payments_api_client->refund_charge( $charge_id, WC_Payments_Utils::prepare_amount( $amount, $order->get_currency() ) );
}
}
$currency = strtoupper( $refund['currency'] );
Tracker::track_admin( 'wcpay_edit_order_refund_success' );
} catch ( Exception $e ) {
$note = sprintf(
/* translators: %1: the successfully charged amount, %2: error message */
__( 'A refund of %1$s failed to complete: %2$s', 'woocommerce-payments' ),
WC_Payments_Explicit_Price_Formatter::get_explicit_price( wc_price( $amount, [ 'currency' => $currency ] ), $order ),
$e->getMessage()
);
Logger::log( $note );
$order->add_order_note( $note );
$order->update_meta_data( '_wcpay_refund_status', 'failed' );
$order->save();
Tracker::track_admin( 'wcpay_edit_order_refund_failure', [ 'reason' => $note ] );
return new WP_Error( 'wcpay_edit_order_refund_failure', $e->getMessage() );
}
if ( empty( $reason ) ) {
$note = sprintf(
WC_Payments_Utils::esc_interpolated_html(
/* translators: %1: the successfully charged amount, %2: refund id */
__( 'A refund of %1$s was successfully processed using WooCommerce Payments (<code>%2$s</code>).', 'woocommerce-payments' ),
[
'code' => '<code>',
]
),
WC_Payments_Explicit_Price_Formatter::get_explicit_price( wc_price( $amount, [ 'currency' => $currency ] ), $order ),
$refund['id']
);
} else {
$note = sprintf(
WC_Payments_Utils::esc_interpolated_html(
/* translators: %1: the successfully charged amount, %2: refund id, %3: reason */
__( 'A refund of %1$s was successfully processed using WooCommerce Payments. Reason: %2$s. (<code>%3$s</code>)', 'woocommerce-payments' ),
[
'code' => '<code>',
]
),
WC_Payments_Explicit_Price_Formatter::get_explicit_price( wc_price( $amount, [ 'currency' => $currency ] ), $order ),
$reason,
$refund['id']
);
}
// Get the last created WC refund from order and save WCPay refund id as meta.
$wc_last_refund = WC_Payments_Utils::get_last_refund_from_order_id( $order_id );
if ( $wc_last_refund ) {
$wc_last_refund->update_meta_data( '_wcpay_refund_id', $refund['id'] );
$wc_last_refund->save_meta_data();
}
$order->add_order_note( $note );
$order->update_meta_data( '_wcpay_refund_status', 'successful' );
$order->save();
return true;
}
/**
* Checks whether a refund through the gateway has already failed.
*
* @param WC_Order $order The order to check.
* @return boolean
*/
public function has_refund_failed( $order ) {
return 'failed' === $order->get_meta( '_wcpay_refund_status', true );
}
/**
* Gets the payment method type used for an order, if any
*
* @param WC_Order $order The order to get the payment method type for.
* @return string
*/
private function get_payment_method_type_for_order( $order ): string {
if ( $order->meta_exists( '_payment_method_id' ) && '' !== $order->get_meta( '_payment_method_id', true ) ) {
$payment_method_id = $order->get_meta( '_payment_method_id', true );
$payment_method_details = $this->payments_api_client->get_payment_method( $payment_method_id );
} elseif ( $order->meta_exists( '_intent_id' ) ) {
$payment_intent_id = $order->get_meta( '_intent_id', true );
$payment_intent = $this->payments_api_client->get_intent( $payment_intent_id );
$charge = $payment_intent ? $payment_intent->get_charge() : null;
$payment_method_details = $charge ? $charge->get_payment_method_details() : [];
}
return $payment_method_details['type'] ?? 'unknown';
}
/**
* Overrides the original method in woo's WC_Settings_API in order to conditionally render the enabled checkbox.
*
* @param string $key Field key.
* @param array $data Field data.
*
* @return string Checkbox markup or empty string.
*/
public function generate_checkbox_html( $key, $data ) {
if ( 'enabled' === $key && ! $this->is_connected() ) {
return '';
}
$in_dev_mode = $this->is_in_dev_mode();
if ( 'test_mode' === $key && $in_dev_mode ) {
$data['custom_attributes']['disabled'] = 'disabled';
$data['label'] = __( 'Dev mode is active so all transactions will be in test mode. This setting is only available to live accounts.', 'woocommerce-payments' );
}
if ( 'enable_logging' === $key && $in_dev_mode ) {
$data['custom_attributes']['disabled'] = 'disabled';
$data['label'] = __( 'Dev mode is active so logging is on by default.', 'woocommerce-payments' );
}
return parent::generate_checkbox_html( $key, $data );
}
/**
* Generates markup for account statement descriptor field.
*
* @param string $key Field key.
* @param array $data Field data.
*
* @return string
*/
public function generate_account_statement_descriptor_html( $key, $data ) {
if ( ! $this->is_connected() ) {
return '';
}
return parent::generate_text_html( $key, $data );
}
/**
* Get option from DB or connected account.
*
* Overrides parent method to retrieve some options from connected account.
*
* @param string $key Option key.
* @param mixed $empty_value Value when empty.
* @return string|array|int|bool The value specified for the option or a default value for the option.
*/
public function get_option( $key, $empty_value = null ) {
switch ( $key ) {
case 'enabled':
return parent::get_option( static::METHOD_ENABLED_KEY, $empty_value );
case 'account_statement_descriptor':
return $this->get_account_statement_descriptor();
case 'account_business_name':
return $this->get_account_business_name();
case 'account_business_url':
return $this->get_account_business_url();
case 'account_business_support_address':
return $this->get_account_business_support_address();
case 'account_business_support_email':
return $this->get_account_business_support_email();
case 'account_business_support_phone':
return $this->get_account_business_support_phone();
case 'account_branding_logo':
return $this->get_account_branding_logo();
case 'account_branding_icon':
return $this->get_account_branding_icon();
case 'account_branding_primary_color':
return $this->get_account_branding_primary_color();
case 'account_branding_secondary_color':
return $this->get_account_branding_secondary_color();
case 'deposit_schedule_interval':
return $this->get_deposit_schedule_interval();
case 'deposit_schedule_weekly_anchor':
return $this->get_deposit_schedule_weekly_anchor();
case 'deposit_schedule_monthly_anchor':
return $this->get_deposit_schedule_monthly_anchor();
case 'deposit_delay_days':
return $this->get_deposit_delay_days();
case 'deposit_status':
return $this->get_deposit_status();
case 'deposit_completed_waiting_period':
return $this->get_deposit_completed_waiting_period();
default:
return parent::get_option( $key, $empty_value );
}
}
/**
* Return the name of the option in the WP DB.
* Overrides parent method so the option key is the same as the parent class.
*/
public function get_option_key() {
// Intentionally using self instead of static so options are loaded from main gateway settings.
return $this->plugin_id . self::GATEWAY_ID . '_settings';
}
/**
* Update a single option.
* Overrides parent method to use different key for `enabled`.
*
* @param string $key Option key.
* @param mixed $value Value to set.
* @return bool was anything saved?
*/
public function update_option( $key, $value = '' ) {
if ( 'enabled' === $key ) {
$key = static::METHOD_ENABLED_KEY;
}
return parent::update_option( $key, $value );
}
/**
* Updates whether platform checkout is enabled or disabled.
*
* @param bool $is_platform_checkout_enabled Whether platform checkout should be enabled.
*/
public function update_is_platform_checkout_enabled( $is_platform_checkout_enabled ) {
$current_is_platform_checkout_enabled = 'yes' === $this->get_option( 'platform_checkout', 'no' );
if ( $is_platform_checkout_enabled !== $current_is_platform_checkout_enabled ) {
wc_admin_record_tracks_event(
$is_platform_checkout_enabled ? 'platform_checkout_enabled' : 'platform_checkout_disabled',
[ 'test_mode' => $this->is_in_test_mode() ? 1 : 0 ]
);
$this->update_option( 'platform_checkout', $is_platform_checkout_enabled ? 'yes' : 'no' );
if ( ! $is_platform_checkout_enabled ) {
Platform_Checkout_Order_Status_Sync::remove_webhook();
}
}
}
/**
* Init settings for gateways.
*/
public function init_settings() {
parent::init_settings();
$this->enabled = ! empty( $this->settings[ static::METHOD_ENABLED_KEY ] ) && 'yes' === $this->settings[ static::METHOD_ENABLED_KEY ] ? 'yes' : 'no';
}
/**
* Get payment capture type from WCPay settings.
*
* @return Payment_Capture_Type MANUAL or AUTOMATIC depending on the settings.
*/
protected function get_capture_type() {
return 'yes' === $this->get_option( 'manual_capture' ) ? Payment_Capture_Type::MANUAL() : Payment_Capture_Type::AUTOMATIC();
}
/**
* Map fields that need to be updated and update the fields server side.
*
* @param array $settings Plugin settings.
* @return array Updated fields.
*/
public function update_account_settings( array $settings ) : array {
$account_settings = [];
foreach ( static::ACCOUNT_SETTINGS_MAPPING as $name => $account_key ) {
if ( isset( $settings[ $name ] ) ) {
$account_settings[ $account_key ] = $settings[ $name ];
}
}
$this->update_account( $account_settings );
return $account_settings;
}
/**
* Gets connected account statement descriptor.
*
* @param string $empty_value Empty value to return when not connected or fails to fetch account descriptor.
*
* @return string Statement descriptor of default value.
*/
public function get_account_statement_descriptor( string $empty_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_statement_descriptor();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account statement descriptor.' . $e );
}
return $empty_value;
}
/**
* Gets connected account business name.
*
* @param string $default_value Value to return when not connected or failed to fetch business name.
*
* @return string Business name or default value.
*/
protected function get_account_business_name( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_business_name();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account business url.
*
* @param string $default_value Value to return when not connected or failed to fetch business url.
*
* @return string Business url or default value.
*/
protected function get_account_business_url( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_business_url();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account business address.
*
* @param array $default_value Value to return when not connected or failed to fetch business address.
*
* @return array Business address or default value.
*/
protected function get_account_business_support_address( $default_value = [] ): array {
try {
if ( $this->is_connected() ) {
return $this->account->get_business_support_address();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account business support email.
*
* @param string $default_value Value to return when not connected or failed to fetch business support email.
*
* @return string Business support email or default value.
*/
protected function get_account_business_support_email( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_business_support_email();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account business support phone.
*
* @param string $default_value Value to return when not connected or failed to fetch business support phone.
*
* @return string Business support phone or default value.
*/
protected function get_account_business_support_phone( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_business_support_phone();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account branding logo.
*
* @param string $default_value Value to return when not connected or failed to fetch branding logo.
*
* @return string Business support branding logo or default value.
*/
protected function get_account_branding_logo( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_branding_logo();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account branding icon.
*
* @param string $default_value Value to return when not connected or failed to fetch branding icon.
*
* @return string Business support branding icon or default value.
*/
protected function get_account_branding_icon( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_branding_icon();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Checks if the attached payment intent was successful for the current order.
*
* @param WC_Order $order Current order to check.
*
* @return array|void A successful response in case the attached intent was successful, null if none.
*/
protected function check_payment_intent_attached_to_order_succeeded( WC_Order $order ) {
$intent_id = (string) $order->get_meta( '_intent_id', true );
if ( empty( $intent_id ) ) {
return;
}
// We only care about payment intent.
$is_payment_intent = 'pi_' === substr( $intent_id, 0, 3 );
if ( ! $is_payment_intent ) {
return;
}
try {
$intent = $this->payments_api_client->get_intent( $intent_id );
$intent_status = $intent->get_status();
} catch ( Exception $e ) {
Logger::error( 'Failed to fetch attached payment intent: ' . $e );
return;
};
if ( ! in_array( $intent_status, self::SUCCESSFUL_INTENT_STATUS, true ) ) {
return;
}
$intent_meta_order_id_raw = $intent->get_metadata()['order_id'] ?? '';
$intent_meta_order_id = is_numeric( $intent_meta_order_id_raw ) ? intval( $intent_meta_order_id_raw ) : 0;
if ( $intent_meta_order_id !== $order->get_id() ) {
return;
}
$charge = $intent->get_charge();
$charge_id = $charge ? $charge->get_id() : null;
$this->update_order_status_from_intent( $order, $intent_id, $intent_status, $charge_id );
$return_url = $this->get_return_url( $order );
$return_url = add_query_arg( self::FLAG_PREVIOUS_SUCCESSFUL_INTENT, 'yes', $return_url );
return [
'result' => 'success',
'redirect' => $return_url,
'wcpay_upe_previous_successful_intent' => 'yes', // This flag is needed for UPE flow.
];
}
/**
* Checks if the current order has the same content with the session processing order, which was already paid (ex. by a webhook).
*
* @param WC_Order $current_order Current order in process_payment.
*
* @return array|void A successful response in case the session processing order was paid, null if none.
*/
protected function check_against_session_processing_order( WC_Order $current_order ) {
$session_order_id = $this->get_session_processing_order();
if ( null === $session_order_id ) {
return;
}
$session_order = wc_get_order( $session_order_id );
if ( ! is_a( $session_order, 'WC_Order' ) ) {
return;
}
if ( $current_order->get_cart_hash() !== $session_order->get_cart_hash() ) {
return;
}
if ( ! $session_order->has_status( wc_get_is_paid_statuses() ) ) {
return;
}
$session_order->add_order_note(
sprintf(
/* translators: order ID integer number */
__( 'WooCommerce Payments: detected and deleted order ID %d, which has duplicate cart content with this order.', 'woocommerce-payments' ),
$current_order->get_id()
)
);
$current_order->delete();
$this->remove_session_processing_order( $session_order_id );
$return_url = $this->get_return_url( $session_order );
$return_url = add_query_arg( self::FLAG_PREVIOUS_ORDER_PAID, 'yes', $return_url );
return [
'result' => 'success',
'redirect' => $return_url,
'wcpay_upe_paid_for_previous_order' => 'yes', // This flag is needed for UPE flow.
];
}
/**
* Update the processing order ID for the current session.
*
* @param int $order_id Order ID.
*
* @return void
*/
protected function maybe_update_session_processing_order( int $order_id ) {
if ( WC()->session ) {
WC()->session->set( self::SESSION_KEY_PROCESSING_ORDER, $order_id );
}
}
/**
* Remove the provided order ID from the current session if it matches with the ID in the session.
*
* @param int $order_id Order ID to remove from the session.
*
* @return void
*/
protected function remove_session_processing_order( int $order_id ) {
$current_session_id = $this->get_session_processing_order();
if ( $order_id === $current_session_id && WC()->session ) {
WC()->session->set( self::SESSION_KEY_PROCESSING_ORDER, null );
}
}
/**
* Get the processing order ID for the current session.
*
* @return integer|null Order ID. Null if the value is not set.
*/
protected function get_session_processing_order() {
$session = WC()->session;
if ( null === $session ) {
return null;
}
$val = $session->get( self::SESSION_KEY_PROCESSING_ORDER );
return null === $val ? null : absint( $val );
}
/**
* Action to remove the order ID when customers reach its order-received page.
*
* @return void
*/
public function clear_session_processing_order_after_landing_order_received_page() {
global $wp;
if ( is_order_received_page() && isset( $wp->query_vars['order-received'] ) ) {
$order_id = absint( $wp->query_vars['order-received'] );
$this->remove_session_processing_order( $order_id );
}
}
/**
* Gets connected account branding primary color.
*
* @param string $default_value Value to return when not connected or failed to fetch branding primary color.
*
* @return string Business support branding primary color or default value.
*/
protected function get_account_branding_primary_color( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_branding_primary_color();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account branding secondary color.
*
* @param string $default_value Value to return when not connected or failed to fetch branding secondary color.
*
* @return string Business support branding secondary color or default value.
*/
protected function get_account_branding_secondary_color( $default_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_branding_secondary_color();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get account business name.' . $e );
}
return $default_value;
}
/**
* Gets connected account deposit schedule interval.
*
* @param string $empty_value Empty value to return when not connected or fails to fetch deposit schedule.
*
* @return string Interval or default value.
*/
protected function get_deposit_schedule_interval( string $empty_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_deposit_schedule_interval();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get deposit schedule interval.' . $e );
}
return $empty_value;
}
/**
* Gets connected account deposit schedule weekly anchor.
*
* @param string $empty_value Empty value to return when not connected or fails to fetch deposit schedule weekly anchor.
*
* @return string Weekly anchor or default value.
*/
protected function get_deposit_schedule_weekly_anchor( string $empty_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_deposit_schedule_weekly_anchor();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get deposit schedule weekly anchor.' . $e );
}
return $empty_value;
}
/**
* Gets connected account deposit schedule monthly anchor.
*
* @param int|null $empty_value Empty value to return when not connected or fails to fetch deposit schedule monthly anchor.
*
* @return int|null Monthly anchor or default value.
*/
protected function get_deposit_schedule_monthly_anchor( $empty_value = null ) {
try {
if ( $this->is_connected() ) {
return $this->account->get_deposit_schedule_monthly_anchor();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get deposit schedule monthly anchor.' . $e );
}
return null === $empty_value ? null : (int) $empty_value;
}
/**
* Gets connected account deposit delay days.
*
* @param int $default_value Value to return when not connected or fails to fetch deposit delay days. Default is 7 days.
*
* @return int number of days.
*/
protected function get_deposit_delay_days( int $default_value = 7 ): int {
try {
if ( $this->is_connected() ) {
return $this->account->get_deposit_delay_days() ?? $default_value;
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get deposit delay days.' . $e );
}
return $default_value;
}
/**
* Gets connected account deposit status.
*
* @param string $empty_value Empty value to return when not connected or fails to fetch deposit status.
*
* @return string deposit status or default value.
*/
protected function get_deposit_status( string $empty_value = '' ): string {
try {
if ( $this->is_connected() ) {
return $this->account->get_deposit_status();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get deposit status.' . $e );
}
return $empty_value;
}
/**
* Gets the completed deposit waiting period value.
*
* @param bool $empty_value Empty value to return when not connected or fails to fetch the completed deposit waiting period value.
*
* @return bool The completed deposit waiting period value or default value.
*/
protected function get_deposit_completed_waiting_period( bool $empty_value = false ): bool {
try {
if ( $this->is_connected() ) {
return $this->account->get_deposit_completed_waiting_period();
}
} catch ( Exception $e ) {
Logger::error( 'Failed to get the deposit waiting period value.' . $e );
}
return $empty_value;
}
/**
* Handles connected account update when plugin settings saved.
*
* Adds error message to display in admin notices in case of failure.
*
* @param array $account_settings Stripe account settings.
* Supported: statement_descriptor, business_name, business_url, business_support_address,
* business_support_email, business_support_phone, branding_logo, branding_icon,
* branding_primary_color, branding_secondary_color.
*/
public function update_account( $account_settings ) {
if ( empty( $account_settings ) ) {
return;
}
$error_message = $this->account->update_stripe_account( $account_settings );
if ( is_string( $error_message ) ) {
$msg = __( 'Failed to update Stripe account. ', 'woocommerce-payments' ) . $error_message;
$this->add_error( $msg );
}
}
/**
* Validates statement descriptor value
*
* @param string $key Field key.
* @param string $value Posted Value.
*
* @return string Sanitized statement descriptor.
* @throws InvalidArgumentException When statement descriptor is invalid.
*/
public function validate_account_statement_descriptor_field( $key, $value ) {
// Since the value is escaped, and we are saving in a place that does not require escaping, apply stripslashes.
$value = trim( stripslashes( $value ) );
// Validation can be done with a single regex but splitting into multiple for better readability.
$valid_length = '/^.{5,22}$/';
$has_one_letter = '/^.*[a-zA-Z]+/';
$no_specials = '/^[^*"\'<>]*$/';
if (
! preg_match( $valid_length, $value ) ||
! preg_match( $has_one_letter, $value ) ||
! preg_match( $no_specials, $value )
) {
throw new InvalidArgumentException( __( 'Customer bank statement is invalid. Statement should be between 5 and 22 characters long, contain at least single Latin character and does not contain special characters: \' " * < >', 'woocommerce-payments' ) );
}
return $value;
}
/**
* Add capture and cancel actions for orders with an authorized charge.
*
* @param array $actions - Actions to make available in order actions metabox.
*/
public function add_order_actions( $actions ) {
global $theorder;
if ( ! is_object( $theorder ) ) {
return $actions;
}
if ( $this->id !== $theorder->get_payment_method() ) {
return $actions;
}
if ( Payment_Intent_Status::REQUIRES_CAPTURE !== $theorder->get_meta( '_intention_status', true ) ) {
return $actions;
}
// if order is already completed, we shouldn't capture the charge anymore.
if ( in_array( $theorder->get_status(), wc_get_is_paid_statuses(), true ) ) {
return $actions;
}
$new_actions = [
'capture_charge' => __( 'Capture charge', 'woocommerce-payments' ),
'cancel_authorization' => __( 'Cancel authorization', 'woocommerce-payments' ),
];
return array_merge( $new_actions, $actions );
}
/**
* Capture previously authorized charge.
*
* @param WC_Order $order - Order to capture charge on.
* @param bool $include_level3 - Whether to include level 3 data in payment intent.
*
* @return array An array containing the status (succeeded/failed), id (intent ID), message (error message if any), and http code
*/
public function capture_charge( $order, $include_level3 = true ) {
$amount = $order->get_total();
$is_authorization_expired = false;
$intent = null;
$status = null;
$error_message = null;
$http_code = null;
$currency = WC_Payments_Utils::get_order_intent_currency( $order );
try {
$intent_id = $order->get_transaction_id();
$intent = $this->payments_api_client->get_intent( $intent_id );
$payment_type = $this->is_payment_recurring( $order->get_id() ) ? Payment_Type::RECURRING() : Payment_Type::SINGLE();
$metadata_from_intent = $intent->get_metadata(); // mobile app may have set metadata.
$metadata_from_order = $this->get_metadata_from_order( $order, $payment_type );
$merged_metadata = array_merge( (array) $metadata_from_order, (array) $metadata_from_intent ); // prioritize metadata from mobile app.
$this->payments_api_client->prepare_intention_for_capture(
$intent_id,
$merged_metadata
);
$intent = $this->payments_api_client->capture_intention(
$intent_id,
WC_Payments_Utils::prepare_amount( $amount, $order->get_currency() ),
$include_level3 ? $this->get_level3_data_from_order( $order ) : []
);
$status = $intent->get_status();
$currency = $intent->get_currency();
$http_code = 200;
} catch ( API_Exception $e ) {
try {
$error_message = $e->getMessage();
$http_code = $e->get_http_code();
// Fetch the Intent to check if it's already expired and the site missed the "charge.expired" webhook.
$intent = $this->payments_api_client->get_intent( $order->get_transaction_id() );
if ( Payment_Intent_Status::CANCELED === $intent->get_status() ) {
$is_authorization_expired = true;
}
} catch ( API_Exception $ge ) {
// Ignore any errors during the intent retrieval, and add the failed capture note below with the
// original error message.
$status = null;
$error_message = $e->getMessage();
$http_code = $e->get_http_code();
}
}
Tracker::track_admin( 'wcpay_merchant_captured_auth' );
// There is a possibility of the intent being null, so we need to get the charge_id safely.
$charge = ! empty( $intent ) ? $intent->get_charge() : null;
$charge_id = ! empty( $charge ) ? $charge->get_id() : $order->get_meta( '_charge_id' );
$this->attach_exchange_info_to_order( $order, $charge_id );
if ( Payment_Intent_Status::SUCCEEDED === $status ) {
$this->order_service->mark_payment_capture_completed( $order, $intent_id, $status, $charge_id );
} elseif ( $is_authorization_expired ) {
$this->order_service->mark_payment_capture_expired( $order, $intent_id, Payment_Intent_Status::CANCELED, $charge_id );
} else {
if ( ! empty( $error_message ) ) {
$error_message = esc_html( $error_message );
} else {
$http_code = 502;
}
$this->order_service->mark_payment_capture_failed( $order, $intent_id, Payment_Intent_Status::REQUIRES_CAPTURE, $charge_id, $error_message );
}
return [
'status' => $status ?? 'failed',
'id' => ! empty( $intent ) ? $intent->get_id() : null,
'message' => $error_message,
'http_code' => $http_code,
];
}
/**
* Cancel previously authorized charge.
*
* @param WC_Order $order - Order to cancel authorization on.
*/
public function cancel_authorization( $order ) {
$status = null;
$error_message = null;
try {
$intent = $this->payments_api_client->cancel_intention( $order->get_transaction_id() );
$status = $intent->get_status();
} catch ( API_Exception $e ) {
try {
// Fetch the Intent to check if it's already expired and the site missed the "charge.expired" webhook.
$intent = $this->payments_api_client->get_intent( $order->get_transaction_id() );
$status = $intent->get_status();
if ( Payment_Intent_Status::CANCELED !== $status ) {
$error_message = $e->getMessage();
}
} catch ( API_Exception $ge ) {
// Ignore any errors during the intent retrieval, and add the failed cancellation note below with the
// original error message.
$status = null;
$error_message = $e->getMessage();
}
}
if ( Payment_Intent_Status::CANCELED === $status ) {
$charge = $intent->get_charge();
$charge_id = ! empty( $charge ) ? $charge->get_id() : null;
$this->order_service->mark_payment_capture_cancelled( $order, $intent->get_id(), $status );
return;
} elseif ( ! empty( $error_message ) ) {
$note = sprintf(
WC_Payments_Utils::esc_interpolated_html(
/* translators: %1: error message */
__(
'Canceling authorization <strong>failed</strong> to complete with the following message: <code>%1$s</code>.',
'woocommerce-payments'
),
[
'strong' => '<strong>',
'code' => '<code>',
]
),
esc_html( $error_message )
);
$order->add_order_note( $note );
} else {
$order->add_order_note(
WC_Payments_Utils::esc_interpolated_html(
__( 'Canceling authorization <strong>failed</strong> to complete.', 'woocommerce-payments' ),
[ 'strong' => '<strong>' ]
)
);
}
$order->update_meta_data( '_intention_status', $status );
$order->save();
}
/**
* Create the level 3 data array to send to Stripe when making a purchase.
*
* @param WC_Order $order The order that is being paid for.
* @return array The level 3 data to send to Stripe.
*/
public function get_level3_data_from_order( WC_Order $order ): array {
$merchant_country = $this->account->get_account_country();
// We do not need to send level3 data if merchant account country is non-US.
if ( 'US' !== $merchant_country ) {
return [];
}
// Get the order items. Don't need their keys, only their values.
// Order item IDs are used as keys in the original order items array.
$order_items = array_values( $order->get_items( [ 'line_item', 'fee' ] ) );
$currency = $order->get_currency();
$process_item = static function( $item ) use ( $currency ) {
// Check to see if it is a WC_Order_Item_Product or a WC_Order_Item_Fee.
if ( is_a( $item, 'WC_Order_Item_Product' ) ) {
$subtotal = $item->get_subtotal();
$product_id = $item->get_variation_id()
? $item->get_variation_id()
: $item->get_product_id();
$product_code = substr( $product_id, 0, 12 );
} else {
$subtotal = $item->get_total();
$product_code = substr( sanitize_title( $item->get_name() ), 0, 12 );
}
$description = substr( $item->get_name(), 0, 26 );
$quantity = ceil( $item->get_quantity() );
$tax_amount = WC_Payments_Utils::prepare_amount( $item->get_total_tax(), $currency );
if ( $subtotal >= 0 ) {
$unit_cost = WC_Payments_Utils::prepare_amount( $subtotal / $quantity, $currency );
$discount_amount = WC_Payments_Utils::prepare_amount( $subtotal - $item->get_total(), $currency );
} else {
// It's possible to create products with negative price - represent it as free one with discount.
$discount_amount = abs( WC_Payments_Utils::prepare_amount( $subtotal / $quantity, $currency ) );
$unit_cost = 0;
}
return (object) [
'product_code' => (string) $product_code, // Up to 12 characters that uniquely identify the product.
'product_description' => $description, // Up to 26 characters long describing the product.
'unit_cost' => $unit_cost, // Cost of the product, in cents, as a non-negative integer.
'quantity' => $quantity, // The number of items of this type sold, as a non-negative integer.
'tax_amount' => $tax_amount, // The amount of tax this item had added to it, in cents, as a non-negative integer.
'discount_amount' => $discount_amount, // The amount an item was discounted—if there was a sale,for example, as a non-negative integer.
];
};
$items_to_send = array_map( $process_item, $order_items );
if ( count( $items_to_send ) > 200 ) {
// If more than 200 items are present, bundle the last ones in a single item.
$items_to_send = array_merge(
array_slice( $items_to_send, 0, 199 ),
[ $this->bundle_level3_data_from_items( array_slice( $items_to_send, 200 ) ) ]
);
}
$level3_data = [
'merchant_reference' => (string) $order->get_id(), // An alphanumeric string of up to characters in length. This unique value is assigned by the merchant to identify the order. Also known as an “Order ID”.
'customer_reference' => (string) $order->get_id(),
'shipping_amount' => WC_Payments_Utils::prepare_amount( (float) $order->get_shipping_total() + (float) $order->get_shipping_tax(), $currency ), // The shipping cost, in cents, as a non-negative integer.
'line_items' => $items_to_send,
];
// The customer’s U.S. shipping ZIP code.
$shipping_address_zip = $order->get_shipping_postcode();
if ( WC_Payments_Utils::is_valid_us_zip_code( $shipping_address_zip ) ) {
$level3_data['shipping_address_zip'] = $shipping_address_zip;
}
// The merchant’s U.S. shipping ZIP code.
$store_postcode = get_option( 'woocommerce_store_postcode' );
if ( WC_Payments_Utils::is_valid_us_zip_code( $store_postcode ) ) {
$level3_data['shipping_from_zip'] = $store_postcode;
}
return $level3_data;
}
/**
* 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
*
* @throws Exception - If nonce is invalid.
*/
public function update_order_status() {
try {
$is_nonce_valid = check_ajax_referer( 'wcpay_update_order_status_nonce', false, false );
if ( ! $is_nonce_valid ) {
throw new Process_Payment_Exception(
__( "We're not able to process this payment. Please refresh the page and try again.", 'woocommerce-payments' ),
'invalid_referrer'
);
}
$order_id = isset( $_POST['order_id'] ) ? absint( $_POST['order_id'] ) : false;
$order = wc_get_order( $order_id );
if ( ! $order ) {
throw new Process_Payment_Exception(
__( "We're not able to process this payment. Please try again later.", 'woocommerce-payments' ),
'order_not_found'
);
}
$intent_id = $order->get_meta( '_intent_id', true );
$intent_id_received = isset( $_POST['intent_id'] )
? sanitize_text_field( wp_unslash( $_POST['intent_id'] ) )
/* translators: This will be used to indicate an unknown value for an ID. */
: __( 'unknown', 'woocommerce-payments' );
if ( empty( $intent_id ) ) {
throw new Intent_Authentication_Exception(
__( "We're not able to process this payment. Please try again later.", 'woocommerce-payments' ),
'empty_intent_id'
);
}
$payment_method_id = isset( $_POST['payment_method_id'] ) ? wc_clean( wp_unslash( $_POST['payment_method_id'] ) ) : '';
if ( 'null' === $payment_method_id ) {
$payment_method_id = '';
}
// Check that the intent saved in the order matches the intent used as part of the
// authentication process. The ID of the intent used is sent with
// the AJAX request. We are about to use the status of the intent saved in
// the order, so we need to make sure the intent that was used for authentication
// is the same as the one we're using to update the status.
if ( $intent_id !== $intent_id_received ) {
throw new Intent_Authentication_Exception(
__( "We're not able to process this payment. Please try again later.", 'woocommerce-payments' ),
'intent_id_mismatch'
);
}
$amount = $order->get_total();
if ( $amount > 0 ) {
// An exception is thrown if an intent can't be found for the given intent ID.
$intent = $this->payments_api_client->get_intent( $intent_id );
$status = $intent->get_status();
$charge = $intent->get_charge();
$charge_id = ! empty( $charge ) ? $charge->get_id() : null;
$this->attach_exchange_info_to_order( $order, $charge_id );
$this->attach_intent_info_to_order( $order, $intent_id, $status, $intent->get_payment_method_id(), $intent->get_customer_id(), $charge_id, $intent->get_currency() );
} else {
// For $0 orders, fetch the Setup Intent instead.
$intent = $this->payments_api_client->get_setup_intent( $intent_id );
$status = $intent['status'];
$charge_id = '';
}
switch ( $status ) {
case Payment_Intent_Status::SUCCEEDED:
$this->remove_session_processing_order( $order->get_id() );
$this->order_service->mark_payment_completed( $order, $intent_id, $status, $charge_id );
break;
case Payment_Intent_Status::PROCESSING:
case Payment_Intent_Status::REQUIRES_CAPTURE:
$this->order_service->mark_payment_authorized( $order, $intent_id, $status, $charge_id );
break;
case Payment_Intent_Status::REQUIRES_PAYMENT_METHOD:
$this->order_service->mark_payment_failed( $order, $intent_id, $status, $charge_id );
break;
}
if ( in_array( $status, self::SUCCESSFUL_INTENT_STATUS, true ) ) {
wc_reduce_stock_levels( $order_id );
WC()->cart->empty_cart();
if ( ! empty( $payment_method_id ) ) {
try {
$token = $this->token_service->add_payment_method_to_user( $payment_method_id, wp_get_current_user() );
$this->add_token_to_order( $order, $token );
} catch ( Exception $e ) {
// If saving the token fails, log the error message but catch the error to avoid crashing the checkout flow.
Logger::log( 'Error when saving payment method: ' . $e->getMessage() );
}
}
// Send back redirect URL in the successful case.
echo wp_json_encode(
[
'return_url' => $this->get_return_url( $order ),
]
);
wp_die();
}
} catch ( Intent_Authentication_Exception $e ) {
$error_code = $e->get_error_code();
switch ( $error_code ) {
case 'intent_id_mismatch':
case 'empty_intent_id': // The empty_intent_id case needs the same handling.
$note = sprintf(
WC_Payments_Utils::esc_interpolated_html(
/* translators: %1: transaction ID of the payment or a translated string indicating an unknown ID. */
__( 'A payment with ID <code>%1$s</code> 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-payments' ),
[
'code' => '<code>',
]
),
$intent_id_received
);
$order->add_order_note( $note );
break;
}
// Send back error so it can be displayed to the customer.
echo wp_json_encode(
[
'error' => [
'message' => $e->getMessage(),
],
]
);
wp_die();
} catch ( Exception $e ) {
// Send back error so it can be displayed to the customer.
echo wp_json_encode(
[
'error' => [
'message' => $e->getMessage(),
],
]
);
wp_die();
}
}
/**
* Add payment method via account screen.
*
* @throws Add_Payment_Method_Exception If payment method is missing.
*/
public function add_payment_method() {
try {
// phpcs:ignore WordPress.Security.NonceVerification.Missing
if ( ! isset( $_POST['wcpay-setup-intent'] ) ) {
throw new Add_Payment_Method_Exception(
__( 'A WooCommerce Payments payment method was not provided', 'woocommerce-payments' ),
'payment_method_intent_not_provided'
);
}
// phpcs:ignore WordPress.Security.NonceVerification.Missing,WordPress.Security.ValidatedSanitizedInput.MissingUnslash
$setup_intent_id = ! empty( $_POST['wcpay-setup-intent'] ) ? wc_clean( $_POST['wcpay-setup-intent'] ) : false;
$customer_id = $this->customer_service->get_customer_id_by_user_id( get_current_user_id() );
if ( ! $setup_intent_id || null === $customer_id ) {
throw new Add_Payment_Method_Exception(
__( "We're not able to add this payment method. Please try again later", 'woocommerce-payments' ),
'invalid_setup_intent_id'
);
}
$setup_intent = $this->payments_api_client->get_setup_intent( $setup_intent_id );
if ( Payment_Intent_Status::SUCCEEDED !== $setup_intent['status'] ) {
throw new Add_Payment_Method_Exception(
__( 'Failed to add the provided payment method. Please try again later', 'woocommerce-payments' ),
'invalid_response_status'
);
}
$payment_method = $setup_intent['payment_method'];
$this->token_service->add_payment_method_to_user( $payment_method, wp_get_current_user() );
return [
'result' => 'success',
'redirect' => apply_filters( 'wcpay_get_add_payment_method_redirect_url', wc_get_endpoint_url( 'payment-methods' ) ),
];
} catch ( Exception $e ) {
wc_add_notice( WC_Payments_Utils::get_filtered_error_message( $e ), 'error', [ 'icon' => 'error' ] );
Logger::log( 'Error when adding payment method: ' . $e->getMessage() );
return [
'result' => 'error',
];
}
}
/**
* When an order is created/updated, we want to add an ActionScheduler job to send this data to
* the payment server.
*
* @param int $order_id The ID of the order that has been created.
* @param WC_Order|null $order The order that has been created.
*/
public function schedule_order_tracking( $order_id, $order = null ) {
$this->maybe_schedule_subscription_order_tracking( $order_id, $order );
// If Sift is not enabled, exit out and don't do the tracking here.
if ( ! isset( $this->account->get_fraud_services_config()['sift'] ) ) {
return;
}
// Sometimes the woocommerce_update_order hook might be called with just the order ID parameter,
// so we need to fetch the order here.
if ( is_null( $order ) ) {
$order = wc_get_order( $order_id );
}
// We only want to track orders created by our payment gateway, and orders with a payment method set.
if ( $order->get_payment_method() !== self::GATEWAY_ID || empty( $order->get_meta_data( '_payment_method_id' ) ) ) {
return;
}
// Check whether this is an order we haven't previously tracked a creation event for.
if ( $order->get_meta( '_new_order_tracking_complete' ) !== 'yes' ) {
// Schedule the action to send this information to the payment server.
$this->action_scheduler_service->schedule_job(
strtotime( '+5 seconds' ),
'wcpay_track_new_order',
[ 'order_id' => $order_id ]
);
} else {
// Schedule an update action to send this information to the payment server.
$this->action_scheduler_service->schedule_job(
strtotime( '+5 seconds' ),
'wcpay_track_update_order',
[ 'order_id' => $order_id ]
);
}
}
/**
* Create a payment intent without confirming the intent.
*
* @param WC_Order $order - Order based on which to create intent.
* @param array $payment_methods - A list of allowed payment methods. Eg. card, card_present.
* @param string $capture_method - Controls when the funds will be captured from the customer's account ("automatic" or "manual").
* It must be "manual" for in-person (terminal) payments.
* @param array $metadata - A list of intent metadata.
* @param string|null $customer_id - Customer id for intent.
*
* @return array|WP_Error On success, an array containing info about the newly created intent. On failure, WP_Error object.
*
* @throws Exception - When an error occurs in intent creation.
*/
public function create_intent( WC_Order $order, array $payment_methods, string $capture_method = 'automatic', array $metadata = [], string $customer_id = null ) {
$currency = strtolower( $order->get_currency() );
$converted_amount = WC_Payments_Utils::prepare_amount( $order->get_total(), $currency );
try {
$intent = $this->payments_api_client->create_intention(
$converted_amount,
$currency,
$payment_methods,
$order->get_order_number(),
$capture_method,
$metadata,
$customer_id
);
return [
'id' => ! empty( $intent ) ? $intent->get_id() : null,
];
} catch ( API_Exception $e ) {
return new WP_Error(
'wcpay_intent_creation_error',
sprintf(
// translators: %s: the error message.
__( 'Intent creation failed with the following message: %s', 'woocommerce-payments' ),
$e->getMessage() ?? __( 'Unknown error', 'woocommerce-payments' )
),
[ 'status' => $e->get_http_code() ]
);
}
}
/**
* Create a setup intent when adding cards using the my account page.
*
* @throws Exception - When an error occurs in setup intent creation.
*/
public function create_and_confirm_setup_intent() {
$payment_information = Payment_Information::from_payment_request( $_POST ); // phpcs:ignore WordPress.Security.NonceVerification
$should_save_in_platform_account = false;
// phpcs:ignore WordPress.Security.NonceVerification.Missing
if ( ! empty( $_POST['save_payment_method_in_platform_account'] ) && filter_var( wp_unslash( $_POST['save_payment_method_in_platform_account'] ), FILTER_VALIDATE_BOOLEAN ) ) {
$should_save_in_platform_account = true;
}
// Determine the customer adding the payment method, create one if we don't have one already.
$user = wp_get_current_user();
$customer_id = $this->customer_service->get_customer_id_by_user_id( $user->ID );
if ( null === $customer_id ) {
$customer_data = WC_Payments_Customer_Service::map_customer_data( null, new WC_Customer( $user->ID ) );
$customer_id = $this->customer_service->create_customer_for_user( $user, $customer_data );
}
return $this->payments_api_client->create_and_confirm_setup_intent(
$payment_information->get_payment_method(),
$customer_id,
$should_save_in_platform_account,
$this->is_platform_payment_method( $payment_information->is_using_saved_payment_method() )
);
}
/**
* Handle AJAX request for creating a setup intent when adding cards using the my account page.
*
* @throws Add_Payment_Method_Exception - If nonce or setup intent is invalid.
*/
public function create_setup_intent_ajax() {
try {
$is_nonce_valid = check_ajax_referer( 'wcpay_create_setup_intent_nonce', false, false );
if ( ! $is_nonce_valid ) {
throw new Add_Payment_Method_Exception(
__( "We're not able to add this payment method. Please refresh the page and try again.", 'woocommerce-payments' ),
'invalid_referrer'
);
}
$setup_intent = $this->create_and_confirm_setup_intent();
if ( $setup_intent['client_secret'] ) {
$setup_intent['client_secret'] = WC_Payments_Utils::encrypt_client_secret( $this->account->get_stripe_account_id(), $setup_intent['client_secret'] );
}
wp_send_json_success( $setup_intent, 200 );
} catch ( Exception $e ) {
// Send back error so it can be displayed to the customer.
wp_send_json_error(
[
'error' => [
'message' => WC_Payments_Utils::get_filtered_error_message( $e ),
],
]
);
}
}
/**
* Add a url to the admin order page that links directly to the transactions detail view.
*
* @since 1.4.0
*
* @param WC_Order $order The context passed into this function when the user view the order details page in WordPress admin.
* @return string
*/
public function get_transaction_url( $order ) {
$intent_id = $order->get_meta( '_intent_id', true );
$charge_id = $order->get_meta( '_charge_id', true );
return WC_Payments_Utils::compose_transaction_url( $intent_id, $charge_id );
}
/**
* Returns a formatted token list for a user.
*
* @param int $user_id The user ID.
*/
protected function get_user_formatted_tokens_array( $user_id ) {
$tokens = WC_Payment_Tokens::get_tokens(
[
'user_id' => $user_id,
'gateway_id' => self::GATEWAY_ID,
'limit' => self::USER_FORMATTED_TOKENS_LIMIT,
]
);
return array_map(
static function ( WC_Payment_Token $token ): array {
return [
'tokenId' => $token->get_id(),
'paymentMethodId' => $token->get_token(),
'isDefault' => $token->get_is_default(),
'displayName' => $token->get_display_name(),
];
},
array_values( $tokens )
);
}
/**
* Checks whether the gateway is enabled.
*
* @return bool The result.
*/
public function is_enabled() {
return 'yes' === $this->get_option( 'enabled' );
}
/**
* Disables gateway.
*/
public function disable() {
$this->update_option( 'enabled', 'no' );
}
/**
* Enables gateway.
*/
public function enable() {
$this->update_option( 'enabled', 'yes' );
}
/**
* Returns the list of enabled payment method types for UPE.
*
* @return string[]
*/
public function get_upe_enabled_payment_method_ids() {
return $this->get_option(
'upe_enabled_payment_method_ids',
[
'card',
]
);
}
/**
* Returns the list of statuses and capabilities available for UPE payment methods in the cached account.
*
* @return mixed[] The payment method statuses.
*/
public function get_upe_enabled_payment_method_statuses() {
$account_data = $this->account->get_cached_account_data();
$capabilities = $account_data['capabilities'] ?? [];
$requirements = $account_data['capability_requirements'] ?? [];
$statuses = [];
if ( $capabilities ) {
foreach ( $capabilities as $capability_id => $status ) {
$statuses[ $capability_id ] = [
'status' => $status,
'requirements' => $requirements[ $capability_id ] ?? [],
];
}
}
return 0 === count( $statuses ) ? [
'card_payments' => [
'status' => 'active',
'requirements' => [],
],
] : $statuses;
}
/**
* Returns the mapping list between capability keys and payment type keys
*
* @return string[]
*/
public function get_payment_method_capability_key_map(): array {
return $this->payment_method_capability_key_map;
}
/**
* Updates the account cache with the new payment method status, until it gets fetched again from the server.
*
* @return void
*/
public function refresh_cached_account_data() {
$this->account->refresh_account_data();
}
/**
* Returns the list of enabled payment method types that will function with the current checkout.
*
* @param string $order_id optional Order ID.
* @param bool $force_currency_check optional Whether the currency check is required even if is_admin().
* @return string[]
*/
public function get_payment_method_ids_enabled_at_checkout( $order_id = null, $force_currency_check = false ) {
return [
'card',
];
}
/**
* Returns the list of enabled payment method types that will function with the current checkout filtered by fees.
*
* @param string $order_id optional Order ID.
* @param bool $force_currency_check optional Whether the currency check is required even if is_admin().
* @return string[]
*/
public function get_payment_method_ids_enabled_at_checkout_filtered_by_fees( $order_id = null, $force_currency_check = false ) {
return $this->get_payment_method_ids_enabled_at_checkout( $order_id, $force_currency_check );
}
/**
* Returns the list of available payment method types for UPE.
* See https://stripe.com/docs/stripe-js/payment-element#web-create-payment-intent for a complete list.
*
* @return string[]
*/
public function get_upe_available_payment_methods() {
return [
'card',
];
}
/**
* Text provided to users during onboarding setup.
*
* @return string
*/
public function get_setup_help_text() {
return __( 'Next we’ll ask you to share a few details about your business to create your account.', 'woocommerce-payments' );
}
/**
* Get the connection URL.
*
* @return string Connection URL.
*/
public function get_connection_url() {
if ( WC_Payments_Utils::is_in_onboarding_treatment_mode() ) {
// Configure step button will show `Set up` instead of `Connect`.
return '';
}
$account_data = $this->account->get_cached_account_data();
// The onboarding is finished if account_id is set. `Set up` will be shown instead of `Connect`.
if ( isset( $account_data['account_id'] ) ) {
return '';
}
return html_entity_decode( WC_Payments_Account::get_connect_url( 'WCADMIN_PAYMENT_TASK' ) );
}
/**
* Returns true if the code returned from the API represents an error that should be rate-limited.
*
* @param string $error_code The error code returned from the API.
*
* @return bool Whether the rate limiter should be bumped.
*/
protected function should_bump_rate_limiter( string $error_code ): bool {
return in_array( $error_code, [ 'card_declined', 'incorrect_number', 'incorrect_cvc' ], true );
}
/**
* Returns a bundle of products passed as an argument. Useful when working with Stripe's level 3 data
*
* @param array $items The Stripe's level 3 array of items.
*
* @return object A bundle of the products passed.
*/
public function bundle_level3_data_from_items( array $items ) {
// Total cost is the sum of each product cost * quantity.
$items_count = count( $items );
$total_cost = array_sum(
array_map(
function( $cost, $qty ) {
return $cost * $qty;
},
array_column( $items, 'unit_cost' ),
array_column( $items, 'quantity' )
)
);
return (object) [
'product_code' => (string) substr( uniqid(), 0, 26 ),
'product_description' => "{$items_count} more items",
'unit_cost' => $total_cost,
'quantity' => 1,
'tax_amount' => array_sum( array_column( $items, 'tax_amount' ) ),
'discount_amount' => array_sum( array_column( $items, 'discount_amount' ) ),
];
}
/**
* Move the email field to the top of the Checkout page.
*
* @param array $fields WooCommerce checkout fields.
*
* @return array WooCommerce checkout fields.
*/
public function checkout_update_email_field_priority( $fields ) {
$is_link_enabled = in_array(
Link_Payment_Method::PAYMENT_METHOD_STRIPE_ID,
\WC_Payments::get_gateway()->get_payment_method_ids_enabled_at_checkout_filtered_by_fees( null, true ),
true
);
if ( $is_link_enabled ) {
// Update the field priority.
$fields['billing_email']['priority'] = 1;
// Add extra `wcpay-checkout-email-field` class.
$fields['billing_email']['class'][] = 'wcpay-checkout-email-field';
add_filter( 'woocommerce_form_field_email', [ $this, 'append_stripelink_button' ], 10, 4 );
}
return $fields;
}
/**
* Append StripeLink button within email field for logged in users.
*
* @param string $field - HTML content within email field.
* @param string $key - Key.
* @param array $args - Arguments.
* @param string $value - Default value.
*
* @return string $field - Updated email field content with the button appended.
*/
public function append_stripelink_button( $field, $key, $args, $value ) {
if ( 'billing_email' === $key ) {
$field = str_replace( '</span>', '<button class="wcpay-stripelink-modal-trigger"></button></span>', $field );
}
return $field;
}
/**
* Returns the URL of the configuration screen for this gateway, for use in internal links.
*
* @return string URL of the configuration screen for this gateway
*/
public static function get_settings_url() {
return WC_Payments_Admin_Settings::get_settings_url();
}
// Start: Deprecated functions.
/**
* Whether the current page is the WooCommerce Payments settings page.
*
* @deprecated 5.0.0
*
* @return bool
*/
public static function is_current_page_settings() {
wc_deprecated_function( __FUNCTION__, '5.0.0', 'WC_Payments_Admin_Settings::is_current_page_settings' );
return WC_Payments_Admin_Settings::is_current_page_settings();
}
/**
* Generates the configuration values, needed for payment fields.
*
* Isolated as a separate method in order to be available both
* during the classic checkout, as well as the checkout block.
*
* @deprecated use WC_Payments_Checkout::get_payment_fields_js_config instead.
*
* @return array
*/
public function get_payment_fields_js_config() {
wc_deprecated_function( __FUNCTION__, '5.0.0', 'WC_Payments_Checkout::get_payment_fields_js_config' );
return WC_Payments::get_wc_payments_checkout()->get_payment_fields_js_config();
}
/**
* Prepares customer data to be used on 'Pay for Order' or 'Add Payment Method' pages.
* Customer data is retrieved from order when on Pay for Order.
* Customer data is retrieved from customer when on 'Add Payment Method'.
*
* @deprecated use WC_Payments_Customer_Service::get_prepared_customer_data() instead.
*
* @return array|null An array with customer data or nothing.
*/
public function get_prepared_customer_data() {
wc_deprecated_function( __FUNCTION__, '5.0.0', 'WC_Payments_Customer_Service::get_prepared_customer_data' );
return WC_Payments::get_customer_service()->get_prepared_customer_data();
}
// End: Deprecated functions.
/**
* Determine if current payment method is a platform payment method.
*
* @param boolean $is_using_saved_payment_method If it is using saved payment method.
*
* @return boolean True if it is a platform payment method.
*/
private function is_platform_payment_method( bool $is_using_saved_payment_method ) {
// Return false for express checkout method.
if ( isset( $_POST['payment_request_type'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
return false;
}
// Make sure the payment method being charged was created in the platform.
if (
! $is_using_saved_payment_method &&
$this->should_use_stripe_platform_on_checkout_page()
) {
// This payment method was created under the platform account.
return true;
}
return false;
}
}