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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._api_resource import APIResource
from stripe._expandable_field import ExpandableField
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from stripe._test_helpers import APIResourceTestHelpers
from typing import ClassVar, Dict, List, Optional, cast
from typing_extensions import (
Literal,
NotRequired,
Type,
TypedDict,
Unpack,
TYPE_CHECKING,
)
if TYPE_CHECKING:
from stripe._charge import Charge
from stripe._customer import Customer
from stripe._setup_attempt import SetupAttempt
class ConfirmationToken(APIResource["ConfirmationToken"]):
"""
ConfirmationTokens help transport client side data collected by Stripe JS over
to your server for confirming a PaymentIntent or SetupIntent. If the confirmation
is successful, values present on the ConfirmationToken are written onto the Intent.
To learn more about how to use ConfirmationToken, visit the related guides:
- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)
- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).
"""
OBJECT_NAME: ClassVar[Literal["confirmation_token"]] = "confirmation_token"
class MandateData(StripeObject):
class CustomerAcceptance(StripeObject):
class Online(StripeObject):
ip_address: Optional[str]
"""
The IP address from which the Mandate was accepted by the customer.
"""
user_agent: Optional[str]
"""
The user agent of the browser from which the Mandate was accepted by the customer.
"""
online: Optional[Online]
"""
If this is a Mandate accepted online, this hash contains details about the online acceptance.
"""
type: str
"""
The type of customer acceptance information included with the Mandate.
"""
_inner_class_types = {"online": Online}
customer_acceptance: CustomerAcceptance
"""
This hash contains details about the customer acceptance of the Mandate.
"""
_inner_class_types = {"customer_acceptance": CustomerAcceptance}
class PaymentMethodOptions(StripeObject):
class Card(StripeObject):
cvc_token: Optional[str]
"""
The `cvc_update` Token collected from the Payment Element.
"""
card: Optional[Card]
"""
This hash contains the card payment method options.
"""
_inner_class_types = {"card": Card}
class PaymentMethodPreview(StripeObject):
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.
"""
transit_number: Optional[str]
"""
Transit number of the bank account.
"""
class Affirm(StripeObject):
pass
class AfterpayClearpay(StripeObject):
pass
class Alipay(StripeObject):
pass
class Alma(StripeObject):
pass
class AmazonPay(StripeObject):
pass
class AuBecsDebit(StripeObject):
bsb_number: Optional[str]
"""
Six-digit number identifying bank and branch associated with this 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.
"""
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.
"""
sort_code: Optional[str]
"""
Sort code of the bank account. (e.g., `10-20-30`)
"""
class Bancontact(StripeObject):
pass
class Billie(StripeObject):
pass
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 Blik(StripeObject):
pass
class Boleto(StripeObject):
tax_id: str
"""
Uniquely identifies the customer tax id (CNPJ or CPF)
"""
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 GeneratedFrom(StripeObject):
class PaymentMethodDetails(StripeObject):
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,
}
card_present: Optional[CardPresent]
type: str
"""
The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.
"""
_inner_class_types = {"card_present": CardPresent}
charge: Optional[str]
"""
The charge that created this object.
"""
payment_method_details: Optional[PaymentMethodDetails]
"""
Transaction-specific details of the payment method used in the payment.
"""
setup_attempt: Optional[ExpandableField["SetupAttempt"]]
"""
The ID of the SetupAttempt that generated this PaymentMethod, if any.
"""
_inner_class_types = {
"payment_method_details": PaymentMethodDetails,
}
class Networks(StripeObject):
available: List[str]
"""
All networks available for selection via [payment_method_options.card.network](https://stripe.com/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
"""
preferred: Optional[str]
"""
The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
"""
class ThreeDSecureUsage(StripeObject):
supported: bool
"""
Whether 3D Secure is supported on this card.
"""
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,
}
brand: str
"""
Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
"""
checks: Optional[Checks]
"""
Checks on Card address and CVC if provided.
"""
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.)
"""
display_brand: Optional[str]
"""
The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.
"""
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: str
"""
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
"""
generated_from: Optional[GeneratedFrom]
"""
Details of the original PaymentMethod that created this object.
"""
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: str
"""
The last four digits of the card.
"""
networks: Optional[Networks]
"""
Contains information about card networks that can be used to process the payment.
"""
regulated_status: Optional[Literal["regulated", "unregulated"]]
"""
Status of a card based on the card issuer.
"""
three_d_secure_usage: Optional[ThreeDSecureUsage]
"""
Contains details on how this Card may be used for 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,
"generated_from": GeneratedFrom,
"networks": Networks,
"three_d_secure_usage": ThreeDSecureUsage,
"wallet": Wallet,
}
class CardPresent(StripeObject):
class Networks(StripeObject):
available: List[str]
"""
All networks available for selection via [payment_method_options.card.network](https://stripe.com/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
"""
preferred: Optional[str]
"""
The preferred network for the card.
"""
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 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`.
"""
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.
"""
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.)
"""
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`.
"""
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.
"""
networks: Optional[Networks]
"""
Contains information about card networks that can be used to process the payment.
"""
offline: Optional[Offline]
"""
Details about payment methods collected offline.
"""
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.
"""
wallet: Optional[Wallet]
_inner_class_types = {
"networks": Networks,
"offline": Offline,
"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`.
"""
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, if provided. 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`.
"""
class Giropay(StripeObject):
pass
class Grabpay(StripeObject):
pass
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, if provided. 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, if the bank was provided.
"""
class InteracPresent(StripeObject):
class Networks(StripeObject):
available: List[str]
"""
All networks available for selection via [payment_method_options.card.network](https://stripe.com/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).
"""
preferred: Optional[str]
"""
The preferred network for the card.
"""
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.)
"""
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`.
"""
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.
"""
networks: Optional[Networks]
"""
Contains information about card networks that can be used to process the payment.
"""
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.
"""
_inner_class_types = {"networks": Networks}
class KakaoPay(StripeObject):
pass
class Klarna(StripeObject):
class Dob(StripeObject):
day: Optional[int]
"""
The day of birth, between 1 and 31.
"""
month: Optional[int]
"""
The month of birth, between 1 and 12.
"""
year: Optional[int]
"""
The four-digit year of birth.
"""
dob: Optional[Dob]
"""
The customer's date of birth, if provided.
"""
_inner_class_types = {"dob": Dob}
class Konbini(StripeObject):
pass
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.
"""
last4: Optional[str]
"""
The last four digits of the card. This may not be present for American Express cards.
"""
class Link(StripeObject):
email: Optional[str]
"""
Account owner's email address.
"""
persistent_token: Optional[str]
"""
[Deprecated] This is a legacy parameter that no longer has any function.
"""
class Mobilepay(StripeObject):
pass
class Multibanco(StripeObject):
pass
class NaverPay(StripeObject):
buyer_id: Optional[str]
"""
Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
"""
funding: Literal["card", "points"]
"""
Whether to fund this transaction with Naver Pay points or a card.
"""
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):
pass
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, if provided.
"""
class PayByBank(StripeObject):
pass
class Payco(StripeObject):
pass
class Paynow(StripeObject):
pass
class Paypal(StripeObject):
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.
"""
class Pix(StripeObject):
pass
class Promptpay(StripeObject):
pass
class RevolutPay(StripeObject):
pass
class SamsungPay(StripeObject):
pass
class Satispay(StripeObject):
pass
class SepaDebit(StripeObject):
class GeneratedFrom(StripeObject):
charge: Optional[ExpandableField["Charge"]]
"""
The ID of the Charge that generated this PaymentMethod, if any.
"""
setup_attempt: Optional[ExpandableField["SetupAttempt"]]
"""
The ID of the SetupAttempt that generated this PaymentMethod, if any.
"""
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.
"""
generated_from: Optional[GeneratedFrom]
"""
Information about the object that generated this PaymentMethod.
"""
last4: Optional[str]
"""
Last four characters of the IBAN.
"""
_inner_class_types = {"generated_from": GeneratedFrom}
class Sofort(StripeObject):
country: Optional[str]
"""
Two-letter ISO code representing the country the bank account is located in.
"""
class Swish(StripeObject):
pass
class Twint(StripeObject):
pass
class UsBankAccount(StripeObject):
class Networks(StripeObject):
preferred: Optional[str]
"""
The preferred network.
"""
supported: List[Literal["ach", "us_domestic_wire"]]
"""
All supported networks.
"""
class StatusDetails(StripeObject):
class Blocked(StripeObject):
network_code: Optional[
Literal[
"R02",
"R03",
"R04",
"R05",
"R07",
"R08",
"R10",
"R11",
"R16",
"R20",
"R29",
"R31",
]
]
"""
The ACH network code that resulted in this block.
"""
reason: Optional[
Literal[
"bank_account_closed",
"bank_account_frozen",
"bank_account_invalid_details",
"bank_account_restricted",
"bank_account_unusable",
"debit_not_authorized",
]
]
"""
The reason why this PaymentMethod's fingerprint has been blocked
"""
blocked: Optional[Blocked]
_inner_class_types = {"blocked": Blocked}
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]
"""
The name of the bank.
"""
financial_connections_account: Optional[str]
"""
The ID of the Financial Connections Account used to create the payment method.
"""
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.
"""
networks: Optional[Networks]
"""
Contains information about US bank account networks that can be used.
"""
routing_number: Optional[str]
"""
Routing number of the bank account.
"""
status_details: Optional[StatusDetails]
"""
Contains information about the future reusability of this PaymentMethod.
"""
_inner_class_types = {
"networks": Networks,
"status_details": StatusDetails,
}
class WechatPay(StripeObject):
pass
class Zip(StripeObject):
pass
acss_debit: Optional[AcssDebit]
affirm: Optional[Affirm]
afterpay_clearpay: Optional[AfterpayClearpay]
alipay: Optional[Alipay]
allow_redisplay: Optional[Literal["always", "limited", "unspecified"]]
"""
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
"""
alma: Optional[Alma]
amazon_pay: Optional[AmazonPay]
au_becs_debit: Optional[AuBecsDebit]
bacs_debit: Optional[BacsDebit]
bancontact: Optional[Bancontact]
billie: Optional[Billie]
billing_details: BillingDetails
blik: Optional[Blik]
boleto: Optional[Boleto]
card: Optional[Card]
card_present: Optional[CardPresent]
cashapp: Optional[Cashapp]
customer: Optional[ExpandableField["Customer"]]
"""
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
"""
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_debit: Optional[SepaDebit]
sofort: Optional[Sofort]
swish: Optional[Swish]
twint: Optional[Twint]
type: Literal[
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"interac_present",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"swish",
"twint",
"us_bank_account",
"wechat_pay",
"zip",
]
"""
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
"""
us_bank_account: Optional[UsBankAccount]
wechat_pay: Optional[WechatPay]
zip: Optional[Zip]
_inner_class_types = {
"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,
"billing_details": BillingDetails,
"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_debit": SepaDebit,
"sofort": Sofort,
"swish": Swish,
"twint": Twint,
"us_bank_account": UsBankAccount,
"wechat_pay": WechatPay,
"zip": Zip,
}
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: Address
name: str
"""
Recipient name.
"""
phone: Optional[str]
"""
Recipient phone (including extension).
"""
_inner_class_types = {"address": Address}
class CreateParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
payment_method: NotRequired[str]
"""
ID of an existing PaymentMethod.
"""
payment_method_data: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodData"
]
"""
If provided, this hash will be used to create a PaymentMethod.
"""
return_url: NotRequired[str]
"""
Return URL used to confirm the Intent.
"""
setup_future_usage: NotRequired[Literal["off_session", "on_session"]]
"""
Indicates that you intend to make future payments with this ConfirmationToken's payment method.
The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
"""
shipping: NotRequired["ConfirmationToken.CreateParamsShipping"]
"""
Shipping information for this ConfirmationToken.
"""
class CreateParamsPaymentMethodData(TypedDict):
acss_debit: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataAcssDebit"
]
"""
If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
"""
affirm: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataAffirm"
]
"""
If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
"""
afterpay_clearpay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataAfterpayClearpay"
]
"""
If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
"""
alipay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataAlipay"
]
"""
If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
"""
allow_redisplay: NotRequired[
Literal["always", "limited", "unspecified"]
]
"""
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
"""
alma: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataAlma"
]
"""
If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
"""
amazon_pay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataAmazonPay"
]
"""
If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
"""
au_becs_debit: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataAuBecsDebit"
]
"""
If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
"""
bacs_debit: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataBacsDebit"
]
"""
If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
"""
bancontact: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataBancontact"
]
"""
If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
"""
billie: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataBillie"
]
"""
If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
"""
billing_details: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataBillingDetails"
]
"""
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
"""
blik: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataBlik"
]
"""
If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
"""
boleto: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataBoleto"
]
"""
If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
"""
cashapp: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataCashapp"
]
"""
If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
"""
customer_balance: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataCustomerBalance"
]
"""
If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
"""
eps: NotRequired["ConfirmationToken.CreateParamsPaymentMethodDataEps"]
"""
If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
"""
fpx: NotRequired["ConfirmationToken.CreateParamsPaymentMethodDataFpx"]
"""
If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
"""
giropay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataGiropay"
]
"""
If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
"""
grabpay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataGrabpay"
]
"""
If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
"""
ideal: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataIdeal"
]
"""
If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
"""
interac_present: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataInteracPresent"
]
"""
If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
"""
kakao_pay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataKakaoPay"
]
"""
If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
"""
klarna: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataKlarna"
]
"""
If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
"""
konbini: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataKonbini"
]
"""
If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
"""
kr_card: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataKrCard"
]
"""
If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
"""
link: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataLink"
]
"""
If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
"""
metadata: NotRequired[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`.
"""
mobilepay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataMobilepay"
]
"""
If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
"""
multibanco: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataMultibanco"
]
"""
If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
"""
naver_pay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataNaverPay"
]
"""
If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
"""
nz_bank_account: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataNzBankAccount"
]
"""
If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
"""
oxxo: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataOxxo"
]
"""
If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
"""
p24: NotRequired["ConfirmationToken.CreateParamsPaymentMethodDataP24"]
"""
If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
"""
pay_by_bank: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataPayByBank"
]
"""
If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
"""
payco: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataPayco"
]
"""
If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
"""
paynow: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataPaynow"
]
"""
If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
"""
paypal: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataPaypal"
]
"""
If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
"""
pix: NotRequired["ConfirmationToken.CreateParamsPaymentMethodDataPix"]
"""
If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
"""
promptpay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataPromptpay"
]
"""
If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
"""
radar_options: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataRadarOptions"
]
"""
Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
"""
revolut_pay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataRevolutPay"
]
"""
If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
"""
samsung_pay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataSamsungPay"
]
"""
If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
"""
satispay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataSatispay"
]
"""
If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
"""
sepa_debit: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataSepaDebit"
]
"""
If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
"""
sofort: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataSofort"
]
"""
If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
"""
swish: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataSwish"
]
"""
If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
"""
twint: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataTwint"
]
"""
If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
"""
type: Literal[
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"cashapp",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"swish",
"twint",
"us_bank_account",
"wechat_pay",
"zip",
]
"""
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
"""
us_bank_account: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataUsBankAccount"
]
"""
If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
"""
wechat_pay: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataWechatPay"
]
"""
If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
"""
zip: NotRequired["ConfirmationToken.CreateParamsPaymentMethodDataZip"]
"""
If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
"""
class CreateParamsPaymentMethodDataAcssDebit(TypedDict):
account_number: str
"""
Customer's bank account number.
"""
institution_number: str
"""
Institution number of the customer's bank.
"""
transit_number: str
"""
Transit number of the customer's bank.
"""
class CreateParamsPaymentMethodDataAffirm(TypedDict):
pass
class CreateParamsPaymentMethodDataAfterpayClearpay(TypedDict):
pass
class CreateParamsPaymentMethodDataAlipay(TypedDict):
pass
class CreateParamsPaymentMethodDataAlma(TypedDict):
pass
class CreateParamsPaymentMethodDataAmazonPay(TypedDict):
pass
class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict):
account_number: str
"""
The account number for the bank account.
"""
bsb_number: str
"""
Bank-State-Branch number of the bank account.
"""
class CreateParamsPaymentMethodDataBacsDebit(TypedDict):
account_number: NotRequired[str]
"""
Account number of the bank account that the funds will be debited from.
"""
sort_code: NotRequired[str]
"""
Sort code of the bank account. (e.g., `10-20-30`)
"""
class CreateParamsPaymentMethodDataBancontact(TypedDict):
pass
class CreateParamsPaymentMethodDataBillie(TypedDict):
pass
class CreateParamsPaymentMethodDataBillingDetails(TypedDict):
address: NotRequired[
"Literal['']|ConfirmationToken.CreateParamsPaymentMethodDataBillingDetailsAddress"
]
"""
Billing address.
"""
email: NotRequired["Literal['']|str"]
"""
Email address.
"""
name: NotRequired["Literal['']|str"]
"""
Full name.
"""
phone: NotRequired["Literal['']|str"]
"""
Billing phone number (including extension).
"""
class CreateParamsPaymentMethodDataBillingDetailsAddress(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 CreateParamsPaymentMethodDataBlik(TypedDict):
pass
class CreateParamsPaymentMethodDataBoleto(TypedDict):
tax_id: str
"""
The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
"""
class CreateParamsPaymentMethodDataCashapp(TypedDict):
pass
class CreateParamsPaymentMethodDataCustomerBalance(TypedDict):
pass
class CreateParamsPaymentMethodDataEps(TypedDict):
bank: NotRequired[
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.
"""
class CreateParamsPaymentMethodDataFpx(TypedDict):
account_holder_type: NotRequired[Literal["company", "individual"]]
"""
Account holder type for FPX transaction
"""
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.
"""
class CreateParamsPaymentMethodDataGiropay(TypedDict):
pass
class CreateParamsPaymentMethodDataGrabpay(TypedDict):
pass
class CreateParamsPaymentMethodDataIdeal(TypedDict):
bank: NotRequired[
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. Only use this parameter for existing customers. Don't use it for new customers.
"""
class CreateParamsPaymentMethodDataInteracPresent(TypedDict):
pass
class CreateParamsPaymentMethodDataKakaoPay(TypedDict):
pass
class CreateParamsPaymentMethodDataKlarna(TypedDict):
dob: NotRequired[
"ConfirmationToken.CreateParamsPaymentMethodDataKlarnaDob"
]
"""
Customer's date of birth
"""
class CreateParamsPaymentMethodDataKlarnaDob(TypedDict):
day: int
"""
The day of birth, between 1 and 31.
"""
month: int
"""
The month of birth, between 1 and 12.
"""
year: int
"""
The four-digit year of birth.
"""
class CreateParamsPaymentMethodDataKonbini(TypedDict):
pass
class CreateParamsPaymentMethodDataKrCard(TypedDict):
pass
class CreateParamsPaymentMethodDataLink(TypedDict):
pass
class CreateParamsPaymentMethodDataMobilepay(TypedDict):
pass
class CreateParamsPaymentMethodDataMultibanco(TypedDict):
pass
class CreateParamsPaymentMethodDataNaverPay(TypedDict):
funding: NotRequired[Literal["card", "points"]]
"""
Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
"""
class CreateParamsPaymentMethodDataNzBankAccount(TypedDict):
account_holder_name: NotRequired[str]
"""
The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
"""
account_number: str
"""
The account number for the bank account.
"""
bank_code: str
"""
The numeric code for the bank account's bank.
"""
branch_code: str
"""
The numeric code for the bank account's bank branch.
"""
reference: NotRequired[str]
suffix: str
"""
The suffix of the bank account number.
"""
class CreateParamsPaymentMethodDataOxxo(TypedDict):
pass
class CreateParamsPaymentMethodDataP24(TypedDict):
bank: NotRequired[
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.
"""
class CreateParamsPaymentMethodDataPayByBank(TypedDict):
pass
class CreateParamsPaymentMethodDataPayco(TypedDict):
pass
class CreateParamsPaymentMethodDataPaynow(TypedDict):
pass
class CreateParamsPaymentMethodDataPaypal(TypedDict):
pass
class CreateParamsPaymentMethodDataPix(TypedDict):
pass
class CreateParamsPaymentMethodDataPromptpay(TypedDict):
pass
class CreateParamsPaymentMethodDataRadarOptions(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 CreateParamsPaymentMethodDataRevolutPay(TypedDict):
pass
class CreateParamsPaymentMethodDataSamsungPay(TypedDict):
pass
class CreateParamsPaymentMethodDataSatispay(TypedDict):
pass
class CreateParamsPaymentMethodDataSepaDebit(TypedDict):
iban: str
"""
IBAN of the bank account.
"""
class CreateParamsPaymentMethodDataSofort(TypedDict):
country: Literal["AT", "BE", "DE", "ES", "IT", "NL"]
"""
Two-letter ISO code representing the country the bank account is located in.
"""
class CreateParamsPaymentMethodDataSwish(TypedDict):
pass
class CreateParamsPaymentMethodDataTwint(TypedDict):
pass
class CreateParamsPaymentMethodDataUsBankAccount(TypedDict):
account_holder_type: NotRequired[Literal["company", "individual"]]
"""
Account holder type: individual or company.
"""
account_number: NotRequired[str]
"""
Account number of the bank account.
"""
account_type: NotRequired[Literal["checking", "savings"]]
"""
Account type: checkings or savings. Defaults to checking if omitted.
"""
financial_connections_account: NotRequired[str]
"""
The ID of a Financial Connections Account to use as a payment method.
"""
routing_number: NotRequired[str]
"""
Routing number of the bank account.
"""
class CreateParamsPaymentMethodDataWechatPay(TypedDict):
pass
class CreateParamsPaymentMethodDataZip(TypedDict):
pass
class CreateParamsShipping(TypedDict):
address: "ConfirmationToken.CreateParamsShippingAddress"
"""
Shipping address
"""
name: str
"""
Recipient name.
"""
phone: NotRequired["Literal['']|str"]
"""
Recipient phone (including extension)
"""
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 RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
expires_at: Optional[int]
"""
Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.
"""
id: str
"""
Unique identifier for the object.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
mandate_data: Optional[MandateData]
"""
Data used for generating a Mandate.
"""
object: Literal["confirmation_token"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
payment_intent: Optional[str]
"""
ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
"""
payment_method_options: Optional[PaymentMethodOptions]
"""
Payment-method-specific configuration for this ConfirmationToken.
"""
payment_method_preview: Optional[PaymentMethodPreview]
"""
Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
"""
return_url: Optional[str]
"""
Return URL used to confirm the Intent.
"""
setup_future_usage: Optional[Literal["off_session", "on_session"]]
"""
Indicates that you intend to make future payments with this ConfirmationToken's payment method.
The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
"""
setup_intent: Optional[str]
"""
ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
"""
shipping: Optional[Shipping]
"""
Shipping information collected on this ConfirmationToken.
"""
use_stripe_sdk: bool
"""
Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.
"""
@classmethod
def retrieve(
cls, id: str, **params: Unpack["ConfirmationToken.RetrieveParams"]
) -> "ConfirmationToken":
"""
Retrieves an existing ConfirmationToken object
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["ConfirmationToken.RetrieveParams"]
) -> "ConfirmationToken":
"""
Retrieves an existing ConfirmationToken object
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
class TestHelpers(APIResourceTestHelpers["ConfirmationToken"]):
_resource_cls: Type["ConfirmationToken"]
@classmethod
def create(
cls, **params: Unpack["ConfirmationToken.CreateParams"]
) -> "ConfirmationToken":
"""
Creates a test mode Confirmation Token server side for your integration tests.
"""
return cast(
"ConfirmationToken",
cls._static_request(
"post",
"/v1/test_helpers/confirmation_tokens",
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["ConfirmationToken.CreateParams"]
) -> "ConfirmationToken":
"""
Creates a test mode Confirmation Token server side for your integration tests.
"""
return cast(
"ConfirmationToken",
await cls._static_request_async(
"post",
"/v1/test_helpers/confirmation_tokens",
params=params,
),
)
@property
def test_helpers(self):
return self.TestHelpers(self)
_inner_class_types = {
"mandate_data": MandateData,
"payment_method_options": PaymentMethodOptions,
"payment_method_preview": PaymentMethodPreview,
"shipping": Shipping,
}
ConfirmationToken.TestHelpers._resource_cls = ConfirmationToken
|