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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._nested_resource_class_methods import nested_resource_class_methods
from stripe._request_options import RequestOptions
from stripe._search_result_object import SearchResultObject
from stripe._searchable_api_resource import SearchableAPIResource
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import class_method_variant, sanitize_id
from typing import (
AsyncIterator,
ClassVar,
Dict,
Iterator,
List,
Optional,
Union,
cast,
overload,
)
from typing_extensions import (
Literal,
NotRequired,
TypedDict,
Unpack,
TYPE_CHECKING,
)
if TYPE_CHECKING:
from stripe._account import Account
from stripe._application import Application
from stripe._application_fee import ApplicationFee
from stripe._balance_transaction import BalanceTransaction
from stripe._bank_account import BankAccount
from stripe._card import Card as CardResource
from stripe._customer import Customer
from stripe._mandate import Mandate
from stripe._payment_intent import PaymentIntent
from stripe._payment_method import PaymentMethod
from stripe._refund import Refund
from stripe._review import Review
from stripe._source import Source
from stripe._transfer import Transfer
@nested_resource_class_methods("refund")
class Charge(
CreateableAPIResource["Charge"],
ListableAPIResource["Charge"],
SearchableAPIResource["Charge"],
UpdateableAPIResource["Charge"],
):
"""
The `Charge` object represents a single attempt to move money into your Stripe account.
PaymentIntent confirmation is the most common way to create Charges, but transferring
money to a different Stripe account through Connect also creates Charges.
Some legacy payment flows create Charges directly, which is not recommended for new integrations.
"""
OBJECT_NAME: ClassVar[Literal["charge"]] = "charge"
class BillingDetails(StripeObject):
class Address(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: Optional[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
address: Optional[Address]
"""
Billing address.
"""
email: Optional[str]
"""
Email address.
"""
name: Optional[str]
"""
Full name.
"""
phone: Optional[str]
"""
Billing phone number (including extension).
"""
_inner_class_types = {"address": Address}
class FraudDetails(StripeObject):
stripe_report: Optional[str]
"""
Assessments from Stripe. If set, the value is `fraudulent`.
"""
user_report: Optional[str]
"""
Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.
"""
class Level3(StripeObject):
class LineItem(StripeObject):
discount_amount: Optional[int]
product_code: str
product_description: str
quantity: Optional[int]
tax_amount: Optional[int]
unit_cost: Optional[int]
customer_reference: Optional[str]
line_items: List[LineItem]
merchant_reference: str
shipping_address_zip: Optional[str]
shipping_amount: Optional[int]
shipping_from_zip: Optional[str]
_inner_class_types = {"line_items": LineItem}
class Outcome(StripeObject):
class Rule(StripeObject):
action: str
"""
The action taken on the payment.
"""
id: str
"""
Unique identifier for the object.
"""
predicate: str
"""
The predicate to evaluate the payment against.
"""
advice_code: Optional[
Literal["confirm_card_data", "do_not_try_again", "try_again_later"]
]
"""
An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
"""
network_advice_code: Optional[str]
"""
For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
"""
network_decline_code: Optional[str]
"""
For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
"""
network_status: Optional[str]
"""
Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
"""
reason: Optional[str]
"""
An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
"""
risk_level: Optional[str]
"""
Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.
"""
risk_score: Optional[int]
"""
Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
"""
rule: Optional[ExpandableField[Rule]]
"""
The ID of the Radar rule that matched the payment, if applicable.
"""
seller_message: Optional[str]
"""
A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
"""
type: str
"""
Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
"""
_inner_class_types = {"rule": Rule}
class PaymentMethodDetails(StripeObject):
class AchCreditTransfer(StripeObject):
account_number: Optional[str]
"""
Account number to transfer funds to.
"""
bank_name: Optional[str]
"""
Name of the bank associated with the routing number.
"""
routing_number: Optional[str]
"""
Routing transit number for the bank account to transfer funds to.
"""
swift_code: Optional[str]
"""
SWIFT code of the bank associated with the routing number.
"""
class AchDebit(StripeObject):
account_holder_type: Optional[Literal["company", "individual"]]
"""
Type of entity that holds the account. This can be either `individual` or `company`.
"""
bank_name: Optional[str]
"""
Name of the bank associated with the bank account.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country the bank account is located in.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
"""
last4: Optional[str]
"""
Last four digits of the bank account number.
"""
routing_number: Optional[str]
"""
Routing transit number of the bank account.
"""
class AcssDebit(StripeObject):
bank_name: Optional[str]
"""
Name of the bank associated with the bank account.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
"""
institution_number: Optional[str]
"""
Institution number of the bank account
"""
last4: Optional[str]
"""
Last four digits of the bank account number.
"""
mandate: Optional[str]
"""
ID of the mandate used to make this payment.
"""
transit_number: Optional[str]
"""
Transit number of the bank account.
"""
class Affirm(StripeObject):
transaction_id: Optional[str]
"""
The Affirm transaction ID associated with this payment.
"""
class AfterpayClearpay(StripeObject):
order_id: Optional[str]
"""
The Afterpay order ID associated with this payment intent.
"""
reference: Optional[str]
"""
Order identifier shown to the merchant in Afterpay's online portal.
"""
class Alipay(StripeObject):
buyer_id: Optional[str]
"""
Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
"""
transaction_id: Optional[str]
"""
Transaction ID of this particular Alipay transaction.
"""
class Alma(StripeObject):
pass
class AmazonPay(StripeObject):
class Funding(StripeObject):
class Card(StripeObject):
brand: Optional[str]
"""
Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
"""
exp_month: Optional[int]
"""
Two-digit number representing the card's expiration month.
"""
exp_year: Optional[int]
"""
Four-digit number representing the card's expiration year.
"""
funding: Optional[str]
"""
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
"""
last4: Optional[str]
"""
The last four digits of the card.
"""
card: Optional[Card]
type: Optional[Literal["card"]]
"""
funding type of the underlying payment method.
"""
_inner_class_types = {"card": Card}
funding: Optional[Funding]
_inner_class_types = {"funding": Funding}
class AuBecsDebit(StripeObject):
bsb_number: Optional[str]
"""
Bank-State-Branch number of the bank account.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
"""
last4: Optional[str]
"""
Last four digits of the bank account number.
"""
mandate: Optional[str]
"""
ID of the mandate used to make this payment.
"""
class BacsDebit(StripeObject):
fingerprint: Optional[str]
"""
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
"""
last4: Optional[str]
"""
Last four digits of the bank account number.
"""
mandate: Optional[str]
"""
ID of the mandate used to make this payment.
"""
sort_code: Optional[str]
"""
Sort code of the bank account. (e.g., `10-20-30`)
"""
class Bancontact(StripeObject):
bank_code: Optional[str]
"""
Bank code of bank associated with the bank account.
"""
bank_name: Optional[str]
"""
Name of the bank associated with the bank account.
"""
bic: Optional[str]
"""
Bank Identifier Code of the bank associated with the bank account.
"""
generated_sepa_debit: Optional[ExpandableField["PaymentMethod"]]
"""
The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
"""
generated_sepa_debit_mandate: Optional[ExpandableField["Mandate"]]
"""
The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
"""
iban_last4: Optional[str]
"""
Last four characters of the IBAN.
"""
preferred_language: Optional[Literal["de", "en", "fr", "nl"]]
"""
Preferred language of the Bancontact authorization page that the customer is redirected to.
Can be one of `en`, `de`, `fr`, or `nl`
"""
verified_name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by Bancontact directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
class Billie(StripeObject):
pass
class Blik(StripeObject):
buyer_id: Optional[str]
"""
A unique and immutable identifier assigned by BLIK to every buyer.
"""
class Boleto(StripeObject):
tax_id: str
"""
The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
"""
class Card(StripeObject):
class Checks(StripeObject):
address_line1_check: Optional[str]
"""
If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
"""
address_postal_code_check: Optional[str]
"""
If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
"""
cvc_check: Optional[str]
"""
If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
"""
class ExtendedAuthorization(StripeObject):
status: Literal["disabled", "enabled"]
"""
Indicates whether or not the capture window is extended beyond the standard authorization.
"""
class IncrementalAuthorization(StripeObject):
status: Literal["available", "unavailable"]
"""
Indicates whether or not the incremental authorization feature is supported.
"""
class Installments(StripeObject):
class Plan(StripeObject):
count: Optional[int]
"""
For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
"""
interval: Optional[Literal["month"]]
"""
For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
One of `month`.
"""
type: Literal["fixed_count"]
"""
Type of installment plan, one of `fixed_count`.
"""
plan: Optional[Plan]
"""
Installment plan selected for the payment.
"""
_inner_class_types = {"plan": Plan}
class Multicapture(StripeObject):
status: Literal["available", "unavailable"]
"""
Indicates whether or not multiple captures are supported.
"""
class NetworkToken(StripeObject):
used: bool
"""
Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
"""
class Overcapture(StripeObject):
maximum_amount_capturable: int
"""
The maximum amount that can be captured.
"""
status: Literal["available", "unavailable"]
"""
Indicates whether or not the authorized amount can be over-captured.
"""
class ThreeDSecure(StripeObject):
authentication_flow: Optional[
Literal["challenge", "frictionless"]
]
"""
For authenticated transactions: how the customer was authenticated by
the issuing bank.
"""
electronic_commerce_indicator: Optional[
Literal["01", "02", "05", "06", "07"]
]
"""
The Electronic Commerce Indicator (ECI). A protocol-level field
indicating what degree of authentication was performed.
"""
exemption_indicator: Optional[Literal["low_risk", "none"]]
"""
The exemption requested via 3DS and accepted by the issuer at authentication time.
"""
exemption_indicator_applied: Optional[bool]
"""
Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on
the outcome of Stripe's internal risk assessment.
"""
result: Optional[
Literal[
"attempt_acknowledged",
"authenticated",
"exempted",
"failed",
"not_supported",
"processing_error",
]
]
"""
Indicates the outcome of 3D Secure authentication.
"""
result_reason: Optional[
Literal[
"abandoned",
"bypassed",
"canceled",
"card_not_enrolled",
"network_not_supported",
"protocol_error",
"rejected",
]
]
"""
Additional information about why 3D Secure succeeded or failed based
on the `result`.
"""
transaction_id: Optional[str]
"""
The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
(dsTransId) for this payment.
"""
version: Optional[Literal["1.0.2", "2.1.0", "2.2.0"]]
"""
The version of 3D Secure that was used.
"""
class Wallet(StripeObject):
class AmexExpressCheckout(StripeObject):
pass
class ApplePay(StripeObject):
pass
class GooglePay(StripeObject):
pass
class Link(StripeObject):
pass
class Masterpass(StripeObject):
class BillingAddress(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: Optional[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
class ShippingAddress(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: Optional[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
billing_address: Optional[BillingAddress]
"""
Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
email: Optional[str]
"""
Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
shipping_address: Optional[ShippingAddress]
"""
Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
_inner_class_types = {
"billing_address": BillingAddress,
"shipping_address": ShippingAddress,
}
class SamsungPay(StripeObject):
pass
class VisaCheckout(StripeObject):
class BillingAddress(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: Optional[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
class ShippingAddress(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: Optional[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
billing_address: Optional[BillingAddress]
"""
Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
email: Optional[str]
"""
Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
shipping_address: Optional[ShippingAddress]
"""
Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
_inner_class_types = {
"billing_address": BillingAddress,
"shipping_address": ShippingAddress,
}
amex_express_checkout: Optional[AmexExpressCheckout]
apple_pay: Optional[ApplePay]
dynamic_last4: Optional[str]
"""
(For tokenized numbers only.) The last four digits of the device account number.
"""
google_pay: Optional[GooglePay]
link: Optional[Link]
masterpass: Optional[Masterpass]
samsung_pay: Optional[SamsungPay]
type: Literal[
"amex_express_checkout",
"apple_pay",
"google_pay",
"link",
"masterpass",
"samsung_pay",
"visa_checkout",
]
"""
The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
"""
visa_checkout: Optional[VisaCheckout]
_inner_class_types = {
"amex_express_checkout": AmexExpressCheckout,
"apple_pay": ApplePay,
"google_pay": GooglePay,
"link": Link,
"masterpass": Masterpass,
"samsung_pay": SamsungPay,
"visa_checkout": VisaCheckout,
}
amount_authorized: Optional[int]
"""
The authorized amount.
"""
authorization_code: Optional[str]
"""
Authorization code on the charge.
"""
brand: Optional[str]
"""
Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
capture_before: Optional[int]
"""
When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
"""
checks: Optional[Checks]
"""
Check results by Card networks on Card address and CVC at time of payment.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
"""
description: Optional[str]
"""
A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
"""
exp_month: int
"""
Two-digit number representing the card's expiration month.
"""
exp_year: int
"""
Four-digit number representing the card's expiration year.
"""
extended_authorization: Optional[ExtendedAuthorization]
fingerprint: Optional[str]
"""
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
"""
funding: Optional[str]
"""
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
"""
iin: Optional[str]
"""
Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
"""
incremental_authorization: Optional[IncrementalAuthorization]
installments: Optional[Installments]
"""
Installment details for this payment (Mexico only).
For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
"""
issuer: Optional[str]
"""
The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
"""
last4: Optional[str]
"""
The last four digits of the card.
"""
mandate: Optional[str]
"""
ID of the mandate used to make this payment or created by it.
"""
moto: Optional[bool]
"""
True if this payment was marked as MOTO and out of scope for SCA.
"""
multicapture: Optional[Multicapture]
network: Optional[str]
"""
Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
network_token: Optional[NetworkToken]
"""
If this card has network token credentials, this contains the details of the network token credentials.
"""
network_transaction_id: Optional[str]
"""
This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
"""
overcapture: Optional[Overcapture]
regulated_status: Optional[Literal["regulated", "unregulated"]]
"""
Status of a card based on the card issuer.
"""
three_d_secure: Optional[ThreeDSecure]
"""
Populated if this transaction used 3D Secure authentication.
"""
wallet: Optional[Wallet]
"""
If this Card is part of a card wallet, this contains the details of the card wallet.
"""
_inner_class_types = {
"checks": Checks,
"extended_authorization": ExtendedAuthorization,
"incremental_authorization": IncrementalAuthorization,
"installments": Installments,
"multicapture": Multicapture,
"network_token": NetworkToken,
"overcapture": Overcapture,
"three_d_secure": ThreeDSecure,
"wallet": Wallet,
}
class CardPresent(StripeObject):
class Offline(StripeObject):
stored_at: Optional[int]
"""
Time at which the payment was collected while offline
"""
type: Optional[Literal["deferred"]]
"""
The method used to process this payment method offline. Only deferred is allowed.
"""
class Receipt(StripeObject):
account_type: Optional[
Literal["checking", "credit", "prepaid", "unknown"]
]
"""
The type of account being debited or credited
"""
application_cryptogram: Optional[str]
"""
EMV tag 9F26, cryptogram generated by the integrated circuit chip.
"""
application_preferred_name: Optional[str]
"""
Mnenomic of the Application Identifier.
"""
authorization_code: Optional[str]
"""
Identifier for this transaction.
"""
authorization_response_code: Optional[str]
"""
EMV tag 8A. A code returned by the card issuer.
"""
cardholder_verification_method: Optional[str]
"""
Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
"""
dedicated_file_name: Optional[str]
"""
EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
"""
terminal_verification_results: Optional[str]
"""
The outcome of a series of EMV functions performed by the card reader.
"""
transaction_status_information: Optional[str]
"""
An indication of various EMV functions performed during the transaction.
"""
class Wallet(StripeObject):
type: Literal[
"apple_pay", "google_pay", "samsung_pay", "unknown"
]
"""
The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
"""
amount_authorized: Optional[int]
"""
The authorized amount
"""
brand: Optional[str]
"""
Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
brand_product: Optional[str]
"""
The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
"""
capture_before: Optional[int]
"""
When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
"""
cardholder_name: Optional[str]
"""
The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
"""
description: Optional[str]
"""
A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
"""
emv_auth_data: Optional[str]
"""
Authorization response cryptogram.
"""
exp_month: int
"""
Two-digit number representing the card's expiration month.
"""
exp_year: int
"""
Four-digit number representing the card's expiration year.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
"""
funding: Optional[str]
"""
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
"""
generated_card: Optional[str]
"""
ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
"""
iin: Optional[str]
"""
Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
"""
incremental_authorization_supported: bool
"""
Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
"""
issuer: Optional[str]
"""
The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
"""
last4: Optional[str]
"""
The last four digits of the card.
"""
network: Optional[str]
"""
Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
network_transaction_id: Optional[str]
"""
This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
"""
offline: Optional[Offline]
"""
Details about payments collected offline.
"""
overcapture_supported: bool
"""
Defines whether the authorized amount can be over-captured or not
"""
preferred_locales: Optional[List[str]]
"""
EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
"""
read_method: Optional[
Literal[
"contact_emv",
"contactless_emv",
"contactless_magstripe_mode",
"magnetic_stripe_fallback",
"magnetic_stripe_track2",
]
]
"""
How card details were read in this transaction.
"""
receipt: Optional[Receipt]
"""
A collection of fields required to be displayed on receipts. Only required for EMV transactions.
"""
wallet: Optional[Wallet]
_inner_class_types = {
"offline": Offline,
"receipt": Receipt,
"wallet": Wallet,
}
class Cashapp(StripeObject):
buyer_id: Optional[str]
"""
A unique and immutable identifier assigned by Cash App to every buyer.
"""
cashtag: Optional[str]
"""
A public identifier for buyers using Cash App.
"""
class CustomerBalance(StripeObject):
pass
class Eps(StripeObject):
bank: Optional[
Literal[
"arzte_und_apotheker_bank",
"austrian_anadi_bank_ag",
"bank_austria",
"bankhaus_carl_spangler",
"bankhaus_schelhammer_und_schattera_ag",
"bawag_psk_ag",
"bks_bank_ag",
"brull_kallmus_bank_ag",
"btv_vier_lander_bank",
"capital_bank_grawe_gruppe_ag",
"deutsche_bank_ag",
"dolomitenbank",
"easybank_ag",
"erste_bank_und_sparkassen",
"hypo_alpeadriabank_international_ag",
"hypo_bank_burgenland_aktiengesellschaft",
"hypo_noe_lb_fur_niederosterreich_u_wien",
"hypo_oberosterreich_salzburg_steiermark",
"hypo_tirol_bank_ag",
"hypo_vorarlberg_bank_ag",
"marchfelder_bank",
"oberbank_ag",
"raiffeisen_bankengruppe_osterreich",
"schoellerbank_ag",
"sparda_bank_wien",
"volksbank_gruppe",
"volkskreditbank_ag",
"vr_bank_braunau",
]
]
"""
The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
"""
verified_name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by EPS directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
EPS rarely provides this information so the attribute is usually empty.
"""
class Fpx(StripeObject):
account_holder_type: Optional[Literal["company", "individual"]]
"""
Account holder type, if provided. Can be one of `individual` or `company`.
"""
bank: Literal[
"affin_bank",
"agrobank",
"alliance_bank",
"ambank",
"bank_islam",
"bank_muamalat",
"bank_of_china",
"bank_rakyat",
"bsn",
"cimb",
"deutsche_bank",
"hong_leong_bank",
"hsbc",
"kfh",
"maybank2e",
"maybank2u",
"ocbc",
"pb_enterprise",
"public_bank",
"rhb",
"standard_chartered",
"uob",
]
"""
The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
"""
transaction_id: Optional[str]
"""
Unique transaction id generated by FPX for every request from the merchant
"""
class Giropay(StripeObject):
bank_code: Optional[str]
"""
Bank code of bank associated with the bank account.
"""
bank_name: Optional[str]
"""
Name of the bank associated with the bank account.
"""
bic: Optional[str]
"""
Bank Identifier Code of the bank associated with the bank account.
"""
verified_name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by Giropay directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Giropay rarely provides this information so the attribute is usually empty.
"""
class Grabpay(StripeObject):
transaction_id: Optional[str]
"""
Unique transaction id generated by GrabPay
"""
class Ideal(StripeObject):
bank: Optional[
Literal[
"abn_amro",
"asn_bank",
"bunq",
"handelsbanken",
"ing",
"knab",
"moneyou",
"n26",
"nn",
"rabobank",
"regiobank",
"revolut",
"sns_bank",
"triodos_bank",
"van_lanschot",
"yoursafe",
]
]
"""
The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
"""
bic: Optional[
Literal[
"ABNANL2A",
"ASNBNL21",
"BITSNL2A",
"BUNQNL2A",
"FVLBNL22",
"HANDNL2A",
"INGBNL2A",
"KNABNL2H",
"MOYONL21",
"NNBANL2G",
"NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
"REVOLT21",
"SNSBNL2A",
"TRIONL2U",
]
]
"""
The Bank Identifier Code of the customer's bank.
"""
generated_sepa_debit: Optional[ExpandableField["PaymentMethod"]]
"""
The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
"""
generated_sepa_debit_mandate: Optional[ExpandableField["Mandate"]]
"""
The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
"""
iban_last4: Optional[str]
"""
Last four characters of the IBAN.
"""
verified_name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by iDEAL directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
class InteracPresent(StripeObject):
class Receipt(StripeObject):
account_type: Optional[
Literal["checking", "savings", "unknown"]
]
"""
The type of account being debited or credited
"""
application_cryptogram: Optional[str]
"""
EMV tag 9F26, cryptogram generated by the integrated circuit chip.
"""
application_preferred_name: Optional[str]
"""
Mnenomic of the Application Identifier.
"""
authorization_code: Optional[str]
"""
Identifier for this transaction.
"""
authorization_response_code: Optional[str]
"""
EMV tag 8A. A code returned by the card issuer.
"""
cardholder_verification_method: Optional[str]
"""
Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
"""
dedicated_file_name: Optional[str]
"""
EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
"""
terminal_verification_results: Optional[str]
"""
The outcome of a series of EMV functions performed by the card reader.
"""
transaction_status_information: Optional[str]
"""
An indication of various EMV functions performed during the transaction.
"""
brand: Optional[str]
"""
Card brand. Can be `interac`, `mastercard` or `visa`.
"""
cardholder_name: Optional[str]
"""
The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
"""
description: Optional[str]
"""
A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
"""
emv_auth_data: Optional[str]
"""
Authorization response cryptogram.
"""
exp_month: int
"""
Two-digit number representing the card's expiration month.
"""
exp_year: int
"""
Four-digit number representing the card's expiration year.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
"""
funding: Optional[str]
"""
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
"""
generated_card: Optional[str]
"""
ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
"""
iin: Optional[str]
"""
Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
"""
issuer: Optional[str]
"""
The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
"""
last4: Optional[str]
"""
The last four digits of the card.
"""
network: Optional[str]
"""
Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
network_transaction_id: Optional[str]
"""
This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
"""
preferred_locales: Optional[List[str]]
"""
EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
"""
read_method: Optional[
Literal[
"contact_emv",
"contactless_emv",
"contactless_magstripe_mode",
"magnetic_stripe_fallback",
"magnetic_stripe_track2",
]
]
"""
How card details were read in this transaction.
"""
receipt: Optional[Receipt]
"""
A collection of fields required to be displayed on receipts. Only required for EMV transactions.
"""
_inner_class_types = {"receipt": Receipt}
class KakaoPay(StripeObject):
buyer_id: Optional[str]
"""
A unique identifier for the buyer as determined by the local payment processor.
"""
class Klarna(StripeObject):
class PayerDetails(StripeObject):
class Address(StripeObject):
country: Optional[str]
"""
The payer address country
"""
address: Optional[Address]
"""
The payer's address
"""
_inner_class_types = {"address": Address}
payer_details: Optional[PayerDetails]
"""
The payer details for this transaction.
"""
payment_method_category: Optional[str]
"""
The Klarna payment method used for this transaction.
Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
"""
preferred_locale: Optional[str]
"""
Preferred language of the Klarna authorization page that the customer is redirected to.
Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`
"""
_inner_class_types = {"payer_details": PayerDetails}
class Konbini(StripeObject):
class Store(StripeObject):
chain: Optional[
Literal["familymart", "lawson", "ministop", "seicomart"]
]
"""
The name of the convenience store chain where the payment was completed.
"""
store: Optional[Store]
"""
If the payment succeeded, this contains the details of the convenience store where the payment was completed.
"""
_inner_class_types = {"store": Store}
class KrCard(StripeObject):
brand: Optional[
Literal[
"bc",
"citi",
"hana",
"hyundai",
"jeju",
"jeonbuk",
"kakaobank",
"kbank",
"kdbbank",
"kookmin",
"kwangju",
"lotte",
"mg",
"nh",
"post",
"samsung",
"savingsbank",
"shinhan",
"shinhyup",
"suhyup",
"tossbank",
"woori",
]
]
"""
The local credit or debit card brand.
"""
buyer_id: Optional[str]
"""
A unique identifier for the buyer as determined by the local payment processor.
"""
last4: Optional[str]
"""
The last four digits of the card. This may not be present for American Express cards.
"""
class Link(StripeObject):
country: Optional[str]
"""
Two-letter ISO code representing the funding source country beneath the Link payment.
You could use this attribute to get a sense of international fees.
"""
class Mobilepay(StripeObject):
class Card(StripeObject):
brand: Optional[str]
"""
Brand of the card used in the transaction
"""
country: Optional[str]
"""
Two-letter ISO code representing the country of the card
"""
exp_month: Optional[int]
"""
Two digit number representing the card's expiration month
"""
exp_year: Optional[int]
"""
Two digit number representing the card's expiration year
"""
last4: Optional[str]
"""
The last 4 digits of the card
"""
card: Optional[Card]
"""
Internal card details
"""
_inner_class_types = {"card": Card}
class Multibanco(StripeObject):
entity: Optional[str]
"""
Entity number associated with this Multibanco payment.
"""
reference: Optional[str]
"""
Reference number associated with this Multibanco payment.
"""
class NaverPay(StripeObject):
buyer_id: Optional[str]
"""
A unique identifier for the buyer as determined by the local payment processor.
"""
class NzBankAccount(StripeObject):
account_holder_name: Optional[str]
"""
The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
"""
bank_code: str
"""
The numeric code for the bank account's bank.
"""
bank_name: str
"""
The name of the bank.
"""
branch_code: str
"""
The numeric code for the bank account's bank branch.
"""
last4: str
"""
Last four digits of the bank account number.
"""
suffix: Optional[str]
"""
The suffix of the bank account number.
"""
class Oxxo(StripeObject):
number: Optional[str]
"""
OXXO reference number
"""
class P24(StripeObject):
bank: Optional[
Literal[
"alior_bank",
"bank_millennium",
"bank_nowy_bfg_sa",
"bank_pekao_sa",
"banki_spbdzielcze",
"blik",
"bnp_paribas",
"boz",
"citi_handlowy",
"credit_agricole",
"envelobank",
"etransfer_pocztowy24",
"getin_bank",
"ideabank",
"ing",
"inteligo",
"mbank_mtransfer",
"nest_przelew",
"noble_pay",
"pbac_z_ipko",
"plus_bank",
"santander_przelew24",
"tmobile_usbugi_bankowe",
"toyota_bank",
"velobank",
"volkswagen_bank",
]
]
"""
The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.
"""
reference: Optional[str]
"""
Unique reference for this Przelewy24 payment.
"""
verified_name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by Przelewy24 directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Przelewy24 rarely provides this information so the attribute is usually empty.
"""
class PayByBank(StripeObject):
pass
class Payco(StripeObject):
buyer_id: Optional[str]
"""
A unique identifier for the buyer as determined by the local payment processor.
"""
class Paynow(StripeObject):
reference: Optional[str]
"""
Reference number associated with this PayNow payment
"""
class Paypal(StripeObject):
class SellerProtection(StripeObject):
dispute_categories: Optional[
List[Literal["fraudulent", "product_not_received"]]
]
"""
An array of conditions that are covered for the transaction, if applicable.
"""
status: Literal[
"eligible", "not_eligible", "partially_eligible"
]
"""
Indicates whether the transaction is eligible for PayPal's seller protection.
"""
country: Optional[str]
"""
Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
payer_email: Optional[str]
"""
Owner's email. Values are provided by PayPal directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
payer_id: Optional[str]
"""
PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
"""
payer_name: Optional[str]
"""
Owner's full name. Values provided by PayPal directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
seller_protection: Optional[SellerProtection]
"""
The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
"""
transaction_id: Optional[str]
"""
A unique ID generated by PayPal for this transaction.
"""
_inner_class_types = {"seller_protection": SellerProtection}
class Pix(StripeObject):
bank_transaction_id: Optional[str]
"""
Unique transaction id generated by BCB
"""
class Promptpay(StripeObject):
reference: Optional[str]
"""
Bill reference generated by PromptPay
"""
class RevolutPay(StripeObject):
class Funding(StripeObject):
class Card(StripeObject):
brand: Optional[str]
"""
Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
"""
exp_month: Optional[int]
"""
Two-digit number representing the card's expiration month.
"""
exp_year: Optional[int]
"""
Four-digit number representing the card's expiration year.
"""
funding: Optional[str]
"""
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
"""
last4: Optional[str]
"""
The last four digits of the card.
"""
card: Optional[Card]
type: Optional[Literal["card"]]
"""
funding type of the underlying payment method.
"""
_inner_class_types = {"card": Card}
funding: Optional[Funding]
_inner_class_types = {"funding": Funding}
class SamsungPay(StripeObject):
buyer_id: Optional[str]
"""
A unique identifier for the buyer as determined by the local payment processor.
"""
class Satispay(StripeObject):
pass
class SepaCreditTransfer(StripeObject):
bank_name: Optional[str]
"""
Name of the bank associated with the bank account.
"""
bic: Optional[str]
"""
Bank Identifier Code of the bank associated with the bank account.
"""
iban: Optional[str]
"""
IBAN of the bank account to transfer funds to.
"""
class SepaDebit(StripeObject):
bank_code: Optional[str]
"""
Bank code of bank associated with the bank account.
"""
branch_code: Optional[str]
"""
Branch code of bank associated with the bank account.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country the bank account is located in.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
"""
last4: Optional[str]
"""
Last four characters of the IBAN.
"""
mandate: Optional[str]
"""
Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
"""
class Sofort(StripeObject):
bank_code: Optional[str]
"""
Bank code of bank associated with the bank account.
"""
bank_name: Optional[str]
"""
Name of the bank associated with the bank account.
"""
bic: Optional[str]
"""
Bank Identifier Code of the bank associated with the bank account.
"""
country: Optional[str]
"""
Two-letter ISO code representing the country the bank account is located in.
"""
generated_sepa_debit: Optional[ExpandableField["PaymentMethod"]]
"""
The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
"""
generated_sepa_debit_mandate: Optional[ExpandableField["Mandate"]]
"""
The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
"""
iban_last4: Optional[str]
"""
Last four characters of the IBAN.
"""
preferred_language: Optional[
Literal["de", "en", "es", "fr", "it", "nl", "pl"]
]
"""
Preferred language of the SOFORT authorization page that the customer is redirected to.
Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
"""
verified_name: Optional[str]
"""
Owner's verified full name. Values are verified or provided by SOFORT directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
"""
class StripeAccount(StripeObject):
pass
class Swish(StripeObject):
fingerprint: Optional[str]
"""
Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
"""
payment_reference: Optional[str]
"""
Payer bank reference number for the payment
"""
verified_phone_last4: Optional[str]
"""
The last four digits of the Swish account phone number
"""
class Twint(StripeObject):
pass
class UsBankAccount(StripeObject):
account_holder_type: Optional[Literal["company", "individual"]]
"""
Account holder type: individual or company.
"""
account_type: Optional[Literal["checking", "savings"]]
"""
Account type: checkings or savings. Defaults to checking if omitted.
"""
bank_name: Optional[str]
"""
Name of the bank associated with the bank account.
"""
fingerprint: Optional[str]
"""
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
"""
last4: Optional[str]
"""
Last four digits of the bank account number.
"""
mandate: Optional[ExpandableField["Mandate"]]
"""
ID of the mandate used to make this payment.
"""
payment_reference: Optional[str]
"""
Reference number to locate ACH payments with customer's bank.
"""
routing_number: Optional[str]
"""
Routing number of the bank account.
"""
class Wechat(StripeObject):
pass
class WechatPay(StripeObject):
fingerprint: Optional[str]
"""
Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
"""
transaction_id: Optional[str]
"""
Transaction ID of this particular WeChat Pay transaction.
"""
class Zip(StripeObject):
pass
ach_credit_transfer: Optional[AchCreditTransfer]
ach_debit: Optional[AchDebit]
acss_debit: Optional[AcssDebit]
affirm: Optional[Affirm]
afterpay_clearpay: Optional[AfterpayClearpay]
alipay: Optional[Alipay]
alma: Optional[Alma]
amazon_pay: Optional[AmazonPay]
au_becs_debit: Optional[AuBecsDebit]
bacs_debit: Optional[BacsDebit]
bancontact: Optional[Bancontact]
billie: Optional[Billie]
blik: Optional[Blik]
boleto: Optional[Boleto]
card: Optional[Card]
card_present: Optional[CardPresent]
cashapp: Optional[Cashapp]
customer_balance: Optional[CustomerBalance]
eps: Optional[Eps]
fpx: Optional[Fpx]
giropay: Optional[Giropay]
grabpay: Optional[Grabpay]
ideal: Optional[Ideal]
interac_present: Optional[InteracPresent]
kakao_pay: Optional[KakaoPay]
klarna: Optional[Klarna]
konbini: Optional[Konbini]
kr_card: Optional[KrCard]
link: Optional[Link]
mobilepay: Optional[Mobilepay]
multibanco: Optional[Multibanco]
naver_pay: Optional[NaverPay]
nz_bank_account: Optional[NzBankAccount]
oxxo: Optional[Oxxo]
p24: Optional[P24]
pay_by_bank: Optional[PayByBank]
payco: Optional[Payco]
paynow: Optional[Paynow]
paypal: Optional[Paypal]
pix: Optional[Pix]
promptpay: Optional[Promptpay]
revolut_pay: Optional[RevolutPay]
samsung_pay: Optional[SamsungPay]
satispay: Optional[Satispay]
sepa_credit_transfer: Optional[SepaCreditTransfer]
sepa_debit: Optional[SepaDebit]
sofort: Optional[Sofort]
stripe_account: Optional[StripeAccount]
swish: Optional[Swish]
twint: Optional[Twint]
type: str
"""
The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
An additional hash is included on `payment_method_details` with a name matching this value.
It contains information specific to the payment method.
"""
us_bank_account: Optional[UsBankAccount]
wechat: Optional[Wechat]
wechat_pay: Optional[WechatPay]
zip: Optional[Zip]
_inner_class_types = {
"ach_credit_transfer": AchCreditTransfer,
"ach_debit": AchDebit,
"acss_debit": AcssDebit,
"affirm": Affirm,
"afterpay_clearpay": AfterpayClearpay,
"alipay": Alipay,
"alma": Alma,
"amazon_pay": AmazonPay,
"au_becs_debit": AuBecsDebit,
"bacs_debit": BacsDebit,
"bancontact": Bancontact,
"billie": Billie,
"blik": Blik,
"boleto": Boleto,
"card": Card,
"card_present": CardPresent,
"cashapp": Cashapp,
"customer_balance": CustomerBalance,
"eps": Eps,
"fpx": Fpx,
"giropay": Giropay,
"grabpay": Grabpay,
"ideal": Ideal,
"interac_present": InteracPresent,
"kakao_pay": KakaoPay,
"klarna": Klarna,
"konbini": Konbini,
"kr_card": KrCard,
"link": Link,
"mobilepay": Mobilepay,
"multibanco": Multibanco,
"naver_pay": NaverPay,
"nz_bank_account": NzBankAccount,
"oxxo": Oxxo,
"p24": P24,
"pay_by_bank": PayByBank,
"payco": Payco,
"paynow": Paynow,
"paypal": Paypal,
"pix": Pix,
"promptpay": Promptpay,
"revolut_pay": RevolutPay,
"samsung_pay": SamsungPay,
"satispay": Satispay,
"sepa_credit_transfer": SepaCreditTransfer,
"sepa_debit": SepaDebit,
"sofort": Sofort,
"stripe_account": StripeAccount,
"swish": Swish,
"twint": Twint,
"us_bank_account": UsBankAccount,
"wechat": Wechat,
"wechat_pay": WechatPay,
"zip": Zip,
}
class PresentmentDetails(StripeObject):
presentment_amount: int
"""
Amount intended to be collected by this payment, denominated in presentment_currency.
"""
presentment_currency: str
"""
Currency presented to the customer during payment.
"""
class RadarOptions(StripeObject):
session: Optional[str]
"""
A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
"""
class Shipping(StripeObject):
class Address(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: Optional[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
address: Optional[Address]
carrier: Optional[str]
"""
The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
"""
name: Optional[str]
"""
Recipient name.
"""
phone: Optional[str]
"""
Recipient phone (including extension).
"""
tracking_number: Optional[str]
"""
The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
"""
_inner_class_types = {"address": Address}
class TransferData(StripeObject):
amount: Optional[int]
"""
The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
"""
destination: ExpandableField["Account"]
"""
ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.
"""
class CaptureParams(RequestOptions):
amount: NotRequired[int]
"""
The amount to capture, which must be less than or equal to the original amount.
"""
application_fee: NotRequired[int]
"""
An application fee to add on to this charge.
"""
application_fee_amount: NotRequired[int]
"""
An application fee amount to add on to this charge, which must be less than or equal to the original amount.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
receipt_email: NotRequired[str]
"""
The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
"""
statement_descriptor: NotRequired[str]
"""
For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
"""
statement_descriptor_suffix: NotRequired[str]
"""
Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
"""
transfer_data: NotRequired["Charge.CaptureParamsTransferData"]
"""
An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
"""
transfer_group: NotRequired[str]
"""
A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
"""
class CaptureParamsTransferData(TypedDict):
amount: NotRequired[int]
"""
The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
"""
class CreateParams(RequestOptions):
amount: NotRequired[int]
"""
Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
"""
application_fee: NotRequired[int]
application_fee_amount: NotRequired[int]
"""
A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).
"""
capture: NotRequired[bool]
"""
Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
"""
currency: NotRequired[str]
"""
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
"""
customer: NotRequired[str]
"""
The ID of an existing customer that will be charged in this request.
"""
description: NotRequired[str]
"""
An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
"""
destination: NotRequired["Charge.CreateParamsDestination"]
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired["Literal['']|Dict[str, str]"]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
on_behalf_of: NotRequired[str]
"""
The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).
"""
radar_options: NotRequired["Charge.CreateParamsRadarOptions"]
"""
Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
"""
receipt_email: NotRequired[str]
"""
The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
"""
shipping: NotRequired["Charge.CreateParamsShipping"]
"""
Shipping information for the charge. Helps prevent fraud on charges for physical goods.
"""
source: NotRequired[str]
"""
A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.
"""
statement_descriptor: NotRequired[str]
"""
For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
"""
statement_descriptor_suffix: NotRequired[str]
"""
Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
"""
transfer_data: NotRequired["Charge.CreateParamsTransferData"]
"""
An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
"""
transfer_group: NotRequired[str]
"""
A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).
"""
class CreateParamsDestination(TypedDict):
account: str
"""
ID of an existing, connected Stripe account.
"""
amount: NotRequired[int]
"""
The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.
"""
class CreateParamsRadarOptions(TypedDict):
session: NotRequired[str]
"""
A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
"""
class CreateParamsShipping(TypedDict):
address: "Charge.CreateParamsShippingAddress"
"""
Shipping address.
"""
carrier: NotRequired[str]
"""
The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
"""
name: str
"""
Recipient name.
"""
phone: NotRequired[str]
"""
Recipient phone (including extension).
"""
tracking_number: NotRequired[str]
"""
The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
"""
class CreateParamsShippingAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: NotRequired[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class CreateParamsTransferData(TypedDict):
amount: NotRequired[int]
"""
The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
"""
destination: str
"""
ID of an existing, connected Stripe account.
"""
class ListParams(RequestOptions):
created: NotRequired["Charge.ListParamsCreated|int"]
"""
Only return charges that were created during the given date interval.
"""
customer: NotRequired[str]
"""
Only return charges for the customer specified by this customer ID.
"""
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
payment_intent: NotRequired[str]
"""
Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
transfer_group: NotRequired[str]
"""
Only return charges for this transfer group, limited to 100.
"""
class ListParamsCreated(TypedDict):
gt: NotRequired[int]
"""
Minimum value to filter by (exclusive)
"""
gte: NotRequired[int]
"""
Minimum value to filter by (inclusive)
"""
lt: NotRequired[int]
"""
Maximum value to filter by (exclusive)
"""
lte: NotRequired[int]
"""
Maximum value to filter by (inclusive)
"""
class ListRefundsParams(RequestOptions):
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
class ModifyParams(RequestOptions):
customer: NotRequired[str]
"""
The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
"""
description: NotRequired[str]
"""
An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
fraud_details: NotRequired["Charge.ModifyParamsFraudDetails"]
"""
A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
"""
metadata: NotRequired["Literal['']|Dict[str, str]"]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
receipt_email: NotRequired[str]
"""
This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
"""
shipping: NotRequired["Charge.ModifyParamsShipping"]
"""
Shipping information for the charge. Helps prevent fraud on charges for physical goods.
"""
transfer_group: NotRequired[str]
"""
A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
"""
class ModifyParamsFraudDetails(TypedDict):
user_report: Union[Literal[""], Literal["fraudulent", "safe"]]
"""
Either `safe` or `fraudulent`.
"""
class ModifyParamsShipping(TypedDict):
address: "Charge.ModifyParamsShippingAddress"
"""
Shipping address.
"""
carrier: NotRequired[str]
"""
The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
"""
name: str
"""
Recipient name.
"""
phone: NotRequired[str]
"""
Recipient phone (including extension).
"""
tracking_number: NotRequired[str]
"""
The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
"""
class ModifyParamsShippingAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: NotRequired[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class RetrieveRefundParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class SearchParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
page: NotRequired[str]
"""
A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
"""
query: str
"""
The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).
"""
amount: int
"""
Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
"""
amount_captured: int
"""
Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
"""
amount_refunded: int
"""
Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
"""
application: Optional[ExpandableField["Application"]]
"""
ID of the Connect application that created the charge.
"""
application_fee: Optional[ExpandableField["ApplicationFee"]]
"""
The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
"""
application_fee_amount: Optional[int]
"""
The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
"""
authorization_code: Optional[str]
"""
Authorization code on the charge.
"""
balance_transaction: Optional[ExpandableField["BalanceTransaction"]]
"""
ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
"""
billing_details: BillingDetails
calculated_statement_descriptor: Optional[str]
"""
The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
"""
captured: bool
"""
If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
currency: str
"""
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
"""
customer: Optional[ExpandableField["Customer"]]
"""
ID of the customer this charge is for if one exists.
"""
description: Optional[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users.
"""
disputed: bool
"""
Whether the charge has been disputed.
"""
failure_balance_transaction: Optional[
ExpandableField["BalanceTransaction"]
]
"""
ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
"""
failure_code: Optional[str]
"""
Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
"""
failure_message: Optional[str]
"""
Message to user further explaining reason for charge failure if available.
"""
fraud_details: Optional[FraudDetails]
"""
Information on fraud assessments for the charge.
"""
id: str
"""
Unique identifier for the object.
"""
level3: Optional[Level3]
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
metadata: Dict[str, str]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
"""
object: Literal["charge"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
on_behalf_of: Optional[ExpandableField["Account"]]
"""
The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
"""
outcome: Optional[Outcome]
"""
Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
"""
paid: bool
"""
`true` if the charge succeeded, or was successfully authorized for later capture.
"""
payment_intent: Optional[ExpandableField["PaymentIntent"]]
"""
ID of the PaymentIntent associated with this charge, if one exists.
"""
payment_method: Optional[str]
"""
ID of the payment method used in this charge.
"""
payment_method_details: Optional[PaymentMethodDetails]
"""
Details about the payment method at the time of the transaction.
"""
presentment_details: Optional[PresentmentDetails]
radar_options: Optional[RadarOptions]
"""
Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
"""
receipt_email: Optional[str]
"""
This is the email address that the receipt for this charge was sent to.
"""
receipt_number: Optional[str]
"""
This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.
"""
receipt_url: Optional[str]
"""
This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
"""
refunded: bool
"""
Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
"""
refunds: Optional[ListObject["Refund"]]
"""
A list of refunds that have been applied to the charge.
"""
review: Optional[ExpandableField["Review"]]
"""
ID of the review associated with this charge if one exists.
"""
shipping: Optional[Shipping]
"""
Shipping information for the charge.
"""
source: Optional[Union["Account", "BankAccount", "CardResource", "Source"]]
"""
This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.
"""
source_transfer: Optional[ExpandableField["Transfer"]]
"""
The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
"""
statement_descriptor: Optional[str]
"""
For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
"""
statement_descriptor_suffix: Optional[str]
"""
Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
"""
status: Literal["failed", "pending", "succeeded"]
"""
The status of the payment is either `succeeded`, `pending`, or `failed`.
"""
transfer: Optional[ExpandableField["Transfer"]]
"""
ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
"""
transfer_data: Optional[TransferData]
"""
An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
"""
transfer_group: Optional[str]
"""
A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
"""
@classmethod
def _cls_capture(
cls, charge: str, **params: Unpack["Charge.CaptureParams"]
) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
return cast(
"Charge",
cls._static_request(
"post",
"/v1/charges/{charge}/capture".format(
charge=sanitize_id(charge)
),
params=params,
),
)
@overload
@staticmethod
def capture(
charge: str, **params: Unpack["Charge.CaptureParams"]
) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
...
@overload
def capture(self, **params: Unpack["Charge.CaptureParams"]) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
...
@class_method_variant("_cls_capture")
def capture( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["Charge.CaptureParams"]
) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
return cast(
"Charge",
self._request(
"post",
"/v1/charges/{charge}/capture".format(
charge=sanitize_id(self.get("id"))
),
params=params,
),
)
@classmethod
async def _cls_capture_async(
cls, charge: str, **params: Unpack["Charge.CaptureParams"]
) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
return cast(
"Charge",
await cls._static_request_async(
"post",
"/v1/charges/{charge}/capture".format(
charge=sanitize_id(charge)
),
params=params,
),
)
@overload
@staticmethod
async def capture_async(
charge: str, **params: Unpack["Charge.CaptureParams"]
) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
...
@overload
async def capture_async(
self, **params: Unpack["Charge.CaptureParams"]
) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
...
@class_method_variant("_cls_capture_async")
async def capture_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["Charge.CaptureParams"]
) -> "Charge":
"""
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
"""
return cast(
"Charge",
await self._request_async(
"post",
"/v1/charges/{charge}/capture".format(
charge=sanitize_id(self.get("id"))
),
params=params,
),
)
@classmethod
def create(cls, **params: Unpack["Charge.CreateParams"]) -> "Charge":
"""
This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents)
to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
object used to request payment.
"""
return cast(
"Charge",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["Charge.CreateParams"]
) -> "Charge":
"""
This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents)
to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
object used to request payment.
"""
return cast(
"Charge",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["Charge.ListParams"]
) -> ListObject["Charge"]:
"""
Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["Charge.ListParams"]
) -> ListObject["Charge"]:
"""
Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def modify(
cls, id: str, **params: Unpack["Charge.ModifyParams"]
) -> "Charge":
"""
Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Charge",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["Charge.ModifyParams"]
) -> "Charge":
"""
Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"Charge",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["Charge.RetrieveParams"]
) -> "Charge":
"""
Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["Charge.RetrieveParams"]
) -> "Charge":
"""
Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
@classmethod
def search(
cls, *args, **kwargs: Unpack["Charge.SearchParams"]
) -> SearchResultObject["Charge"]:
"""
Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cls._search(search_url="/v1/charges/search", *args, **kwargs)
@classmethod
async def search_async(
cls, *args, **kwargs: Unpack["Charge.SearchParams"]
) -> SearchResultObject["Charge"]:
"""
Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return await cls._search_async(
search_url="/v1/charges/search", *args, **kwargs
)
@classmethod
def search_auto_paging_iter(
cls, *args, **kwargs: Unpack["Charge.SearchParams"]
) -> Iterator["Charge"]:
return cls.search(*args, **kwargs).auto_paging_iter()
@classmethod
async def search_auto_paging_iter_async(
cls, *args, **kwargs: Unpack["Charge.SearchParams"]
) -> AsyncIterator["Charge"]:
return (await cls.search_async(*args, **kwargs)).auto_paging_iter()
def mark_as_fraudulent(self, idempotency_key=None) -> "Charge":
params = {
"fraud_details": {"user_report": "fraudulent"},
"idempotency_key": idempotency_key,
}
url = self.instance_url()
self._request_and_refresh("post", url, params)
return self
def mark_as_safe(self, idempotency_key=None) -> "Charge":
params = {
"fraud_details": {"user_report": "safe"},
"idempotency_key": idempotency_key,
}
url = self.instance_url()
self._request_and_refresh("post", url, params)
return self
@classmethod
def retrieve_refund(
cls,
charge: str,
refund: str,
**params: Unpack["Charge.RetrieveRefundParams"],
) -> "Refund":
"""
Retrieves the details of an existing refund.
"""
return cast(
"Refund",
cls._static_request(
"get",
"/v1/charges/{charge}/refunds/{refund}".format(
charge=sanitize_id(charge), refund=sanitize_id(refund)
),
params=params,
),
)
@classmethod
async def retrieve_refund_async(
cls,
charge: str,
refund: str,
**params: Unpack["Charge.RetrieveRefundParams"],
) -> "Refund":
"""
Retrieves the details of an existing refund.
"""
return cast(
"Refund",
await cls._static_request_async(
"get",
"/v1/charges/{charge}/refunds/{refund}".format(
charge=sanitize_id(charge), refund=sanitize_id(refund)
),
params=params,
),
)
@classmethod
def list_refunds(
cls, charge: str, **params: Unpack["Charge.ListRefundsParams"]
) -> ListObject["Refund"]:
"""
You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
"""
return cast(
ListObject["Refund"],
cls._static_request(
"get",
"/v1/charges/{charge}/refunds".format(
charge=sanitize_id(charge)
),
params=params,
),
)
@classmethod
async def list_refunds_async(
cls, charge: str, **params: Unpack["Charge.ListRefundsParams"]
) -> ListObject["Refund"]:
"""
You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
"""
return cast(
ListObject["Refund"],
await cls._static_request_async(
"get",
"/v1/charges/{charge}/refunds".format(
charge=sanitize_id(charge)
),
params=params,
),
)
_inner_class_types = {
"billing_details": BillingDetails,
"fraud_details": FraudDetails,
"level3": Level3,
"outcome": Outcome,
"payment_method_details": PaymentMethodDetails,
"presentment_details": PresentmentDetails,
"radar_options": RadarOptions,
"shipping": Shipping,
"transfer_data": TransferData,
}
|