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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import Dict, List
from typing_extensions import Literal, NotRequired, TypedDict
class SetupIntentUpdateParams(TypedDict):
attach_to_self: NotRequired[bool]
"""
If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
It can only be used for this Stripe Account's own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
"""
customer: NotRequired[str]
"""
ID of the Customer this SetupIntent belongs to, if one exists.
If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
"""
description: NotRequired[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users.
"""
excluded_payment_method_types: NotRequired[
"Literal['']|List[Literal['acss_debit', 'affirm', 'afterpay_clearpay', 'alipay', 'alma', 'amazon_pay', 'au_becs_debit', 'bacs_debit', 'bancontact', 'billie', 'blik', 'boleto', 'card', 'cashapp', 'crypto', 'customer_balance', 'eps', 'fpx', 'giropay', 'grabpay', 'ideal', 'kakao_pay', 'klarna', 'konbini', 'kr_card', 'mb_way', '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 list of payment method types to exclude from use with this SetupIntent.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
flow_directions: NotRequired[List[Literal["inbound", "outbound"]]]
"""
Indicates the directions of money movement for which this payment method is intended to be used.
Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
"""
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`.
"""
payment_method: NotRequired[str]
"""
ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.
"""
payment_method_configuration: NotRequired[str]
"""
The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
"""
payment_method_data: NotRequired[
"SetupIntentUpdateParamsPaymentMethodData"
]
"""
When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
value in the SetupIntent.
"""
payment_method_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptions"
]
"""
Payment method-specific configuration for this SetupIntent.
"""
payment_method_types: NotRequired[List[str]]
"""
The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
"""
class SetupIntentUpdateParamsPaymentMethodData(TypedDict):
acss_debit: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataAcssDebit"
]
"""
If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
"""
affirm: NotRequired["SetupIntentUpdateParamsPaymentMethodDataAffirm"]
"""
If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
"""
afterpay_clearpay: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataAfterpayClearpay"
]
"""
If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
"""
alipay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataAlipay"]
"""
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["SetupIntentUpdateParamsPaymentMethodDataAlma"]
"""
If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
"""
amazon_pay: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataAmazonPay"
]
"""
If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
"""
au_becs_debit: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataAuBecsDebit"
]
"""
If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
"""
bacs_debit: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataBacsDebit"
]
"""
If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
"""
bancontact: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataBancontact"
]
"""
If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
"""
billie: NotRequired["SetupIntentUpdateParamsPaymentMethodDataBillie"]
"""
If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
"""
billing_details: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataBillingDetails"
]
"""
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
"""
blik: NotRequired["SetupIntentUpdateParamsPaymentMethodDataBlik"]
"""
If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
"""
boleto: NotRequired["SetupIntentUpdateParamsPaymentMethodDataBoleto"]
"""
If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
"""
cashapp: NotRequired["SetupIntentUpdateParamsPaymentMethodDataCashapp"]
"""
If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
"""
crypto: NotRequired["SetupIntentUpdateParamsPaymentMethodDataCrypto"]
"""
If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
"""
customer_balance: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataCustomerBalance"
]
"""
If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
"""
eps: NotRequired["SetupIntentUpdateParamsPaymentMethodDataEps"]
"""
If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
"""
fpx: NotRequired["SetupIntentUpdateParamsPaymentMethodDataFpx"]
"""
If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
"""
giropay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataGiropay"]
"""
If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
"""
grabpay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataGrabpay"]
"""
If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
"""
ideal: NotRequired["SetupIntentUpdateParamsPaymentMethodDataIdeal"]
"""
If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
"""
interac_present: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataInteracPresent"
]
"""
If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
"""
kakao_pay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataKakaoPay"]
"""
If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
"""
klarna: NotRequired["SetupIntentUpdateParamsPaymentMethodDataKlarna"]
"""
If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
"""
konbini: NotRequired["SetupIntentUpdateParamsPaymentMethodDataKonbini"]
"""
If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
"""
kr_card: NotRequired["SetupIntentUpdateParamsPaymentMethodDataKrCard"]
"""
If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
"""
link: NotRequired["SetupIntentUpdateParamsPaymentMethodDataLink"]
"""
If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
"""
mb_way: NotRequired["SetupIntentUpdateParamsPaymentMethodDataMbWay"]
"""
If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY 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["SetupIntentUpdateParamsPaymentMethodDataMobilepay"]
"""
If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
"""
multibanco: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataMultibanco"
]
"""
If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
"""
naver_pay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataNaverPay"]
"""
If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
"""
nz_bank_account: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataNzBankAccount"
]
"""
If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
"""
oxxo: NotRequired["SetupIntentUpdateParamsPaymentMethodDataOxxo"]
"""
If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
"""
p24: NotRequired["SetupIntentUpdateParamsPaymentMethodDataP24"]
"""
If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
"""
pay_by_bank: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataPayByBank"
]
"""
If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
"""
payco: NotRequired["SetupIntentUpdateParamsPaymentMethodDataPayco"]
"""
If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
"""
paynow: NotRequired["SetupIntentUpdateParamsPaymentMethodDataPaynow"]
"""
If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
"""
paypal: NotRequired["SetupIntentUpdateParamsPaymentMethodDataPaypal"]
"""
If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
"""
pix: NotRequired["SetupIntentUpdateParamsPaymentMethodDataPix"]
"""
If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
"""
promptpay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataPromptpay"]
"""
If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
"""
radar_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataRadarOptions"
]
"""
Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
"""
revolut_pay: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataRevolutPay"
]
"""
If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
"""
samsung_pay: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataSamsungPay"
]
"""
If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
"""
satispay: NotRequired["SetupIntentUpdateParamsPaymentMethodDataSatispay"]
"""
If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
"""
sepa_debit: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataSepaDebit"
]
"""
If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
"""
sofort: NotRequired["SetupIntentUpdateParamsPaymentMethodDataSofort"]
"""
If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
"""
swish: NotRequired["SetupIntentUpdateParamsPaymentMethodDataSwish"]
"""
If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
"""
twint: NotRequired["SetupIntentUpdateParamsPaymentMethodDataTwint"]
"""
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",
"crypto",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mb_way",
"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[
"SetupIntentUpdateParamsPaymentMethodDataUsBankAccount"
]
"""
If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
"""
wechat_pay: NotRequired[
"SetupIntentUpdateParamsPaymentMethodDataWechatPay"
]
"""
If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
"""
zip: NotRequired["SetupIntentUpdateParamsPaymentMethodDataZip"]
"""
If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
"""
class SetupIntentUpdateParamsPaymentMethodDataAcssDebit(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 SetupIntentUpdateParamsPaymentMethodDataAffirm(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataAfterpayClearpay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataAlipay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataAlma(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataAmazonPay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataAuBecsDebit(TypedDict):
account_number: str
"""
The account number for the bank account.
"""
bsb_number: str
"""
Bank-State-Branch number of the bank account.
"""
class SetupIntentUpdateParamsPaymentMethodDataBacsDebit(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 SetupIntentUpdateParamsPaymentMethodDataBancontact(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataBillie(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataBillingDetails(TypedDict):
address: NotRequired[
"Literal['']|SetupIntentUpdateParamsPaymentMethodDataBillingDetailsAddress"
]
"""
Billing address.
"""
email: NotRequired["Literal['']|str"]
"""
Email address.
"""
name: NotRequired["Literal['']|str"]
"""
Full name.
"""
phone: NotRequired["Literal['']|str"]
"""
Billing phone number (including extension).
"""
tax_id: NotRequired[str]
"""
Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
"""
class SetupIntentUpdateParamsPaymentMethodDataBillingDetailsAddress(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, such as the street, PO Box, or company name.
"""
line2: NotRequired[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class SetupIntentUpdateParamsPaymentMethodDataBlik(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataBoleto(TypedDict):
tax_id: str
"""
The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
"""
class SetupIntentUpdateParamsPaymentMethodDataCashapp(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataCrypto(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataCustomerBalance(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataEps(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 SetupIntentUpdateParamsPaymentMethodDataFpx(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 SetupIntentUpdateParamsPaymentMethodDataGiropay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataGrabpay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataIdeal(TypedDict):
bank: NotRequired[
Literal[
"abn_amro",
"asn_bank",
"bunq",
"buut",
"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 SetupIntentUpdateParamsPaymentMethodDataInteracPresent(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataKakaoPay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataKlarna(TypedDict):
dob: NotRequired["SetupIntentUpdateParamsPaymentMethodDataKlarnaDob"]
"""
Customer's date of birth
"""
class SetupIntentUpdateParamsPaymentMethodDataKlarnaDob(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 SetupIntentUpdateParamsPaymentMethodDataKonbini(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataKrCard(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataLink(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataMbWay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataMobilepay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataMultibanco(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataNaverPay(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 SetupIntentUpdateParamsPaymentMethodDataNzBankAccount(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 SetupIntentUpdateParamsPaymentMethodDataOxxo(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataP24(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 SetupIntentUpdateParamsPaymentMethodDataPayByBank(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataPayco(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataPaynow(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataPaypal(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataPix(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataPromptpay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataRadarOptions(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 SetupIntentUpdateParamsPaymentMethodDataRevolutPay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataSamsungPay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataSatispay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataSepaDebit(TypedDict):
iban: str
"""
IBAN of the bank account.
"""
class SetupIntentUpdateParamsPaymentMethodDataSofort(TypedDict):
country: Literal["AT", "BE", "DE", "ES", "IT", "NL"]
"""
Two-letter ISO code representing the country the bank account is located in.
"""
class SetupIntentUpdateParamsPaymentMethodDataSwish(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataTwint(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataUsBankAccount(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 SetupIntentUpdateParamsPaymentMethodDataWechatPay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodDataZip(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodOptions(TypedDict):
acss_debit: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsAcssDebit"
]
"""
If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
"""
amazon_pay: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsAmazonPay"
]
"""
If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
"""
bacs_debit: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsBacsDebit"
]
"""
If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
"""
card: NotRequired["SetupIntentUpdateParamsPaymentMethodOptionsCard"]
"""
Configuration for any card setup attempted on this SetupIntent.
"""
card_present: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsCardPresent"
]
"""
If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
"""
klarna: NotRequired["SetupIntentUpdateParamsPaymentMethodOptionsKlarna"]
"""
If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.
"""
link: NotRequired["SetupIntentUpdateParamsPaymentMethodOptionsLink"]
"""
If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
"""
paypal: NotRequired["SetupIntentUpdateParamsPaymentMethodOptionsPaypal"]
"""
If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
"""
sepa_debit: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsSepaDebit"
]
"""
If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
"""
us_bank_account: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccount"
]
"""
If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsAcssDebit(TypedDict):
currency: NotRequired[Literal["cad", "usd"]]
"""
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).
"""
mandate_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsAcssDebitMandateOptions"
]
"""
Additional fields for Mandate creation
"""
verification_method: NotRequired[
Literal["automatic", "instant", "microdeposits"]
]
"""
Bank account verification method.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsAcssDebitMandateOptions(
TypedDict,
):
custom_mandate_url: NotRequired["Literal['']|str"]
"""
A URL for custom mandate text to render during confirmation step.
The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
"""
default_for: NotRequired[List[Literal["invoice", "subscription"]]]
"""
List of Stripe products where this mandate can be selected automatically.
"""
interval_description: NotRequired[str]
"""
Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
"""
payment_schedule: NotRequired[Literal["combined", "interval", "sporadic"]]
"""
Payment schedule for the mandate.
"""
transaction_type: NotRequired[Literal["business", "personal"]]
"""
Transaction type of the mandate.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsAmazonPay(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodOptionsBacsDebit(TypedDict):
mandate_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsBacsDebitMandateOptions"
]
"""
Additional fields for Mandate creation
"""
class SetupIntentUpdateParamsPaymentMethodOptionsBacsDebitMandateOptions(
TypedDict,
):
reference_prefix: NotRequired["Literal['']|str"]
"""
Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsCard(TypedDict):
mandate_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsCardMandateOptions"
]
"""
Configuration options for setting up an eMandate for cards issued in India.
"""
moto: NotRequired[bool]
"""
When specified, this parameter signals that a card has been collected
as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
parameter can only be provided during confirmation.
"""
network: NotRequired[
Literal[
"amex",
"cartes_bancaires",
"diners",
"discover",
"eftpos_au",
"girocard",
"interac",
"jcb",
"link",
"mastercard",
"unionpay",
"unknown",
"visa",
]
]
"""
Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
"""
request_three_d_secure: NotRequired[
Literal["any", "automatic", "challenge"]
]
"""
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
"""
three_d_secure: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsCardThreeDSecure"
]
"""
If 3D Secure authentication was performed with a third-party provider,
the authentication details to use for this setup.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsCardMandateOptions(TypedDict):
amount: int
"""
Amount to be charged for future payments.
"""
amount_type: Literal["fixed", "maximum"]
"""
One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
"""
currency: str
"""
Currency in which future payments will be charged. 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).
"""
description: NotRequired[str]
"""
A description of the mandate or subscription that is meant to be displayed to the customer.
"""
end_date: NotRequired[int]
"""
End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
"""
interval: Literal["day", "month", "sporadic", "week", "year"]
"""
Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
"""
interval_count: NotRequired[int]
"""
The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
"""
reference: str
"""
Unique identifier for the mandate or subscription.
"""
start_date: int
"""
Start date of the mandate or subscription. Start date should not be lesser than yesterday.
"""
supported_types: NotRequired[List[Literal["india"]]]
"""
Specifies the type of mandates supported. Possible values are `india`.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict):
ares_trans_status: NotRequired[Literal["A", "C", "I", "N", "R", "U", "Y"]]
"""
The `transStatus` returned from the card Issuer's ACS in the ARes.
"""
cryptogram: NotRequired[str]
"""
The cryptogram, also known as the "authentication value" (AAV, CAVV or
AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
(Most 3D Secure providers will return the base64-encoded version, which
is what you should specify here.)
"""
electronic_commerce_indicator: NotRequired[
Literal["01", "02", "05", "06", "07"]
]
"""
The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
provider and indicates what degree of authentication was performed.
"""
network_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptions"
]
"""
Network specific 3DS fields. Network specific arguments require an
explicit card brand choice. The parameter `payment_method_options.card.network``
must be populated accordingly
"""
requestor_challenge_indicator: NotRequired[str]
"""
The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
"""
transaction_id: NotRequired[str]
"""
For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
Transaction ID (dsTransID).
"""
version: NotRequired[Literal["1.0.2", "2.1.0", "2.2.0"]]
"""
The version of 3D Secure that was performed.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptions(
TypedDict,
):
cartes_bancaires: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires"
]
"""
Cartes Bancaires-specific 3DS fields.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires(
TypedDict,
):
cb_avalgo: Literal["0", "1", "2", "3", "4", "A"]
"""
The cryptogram calculation algorithm used by the card Issuer's ACS
to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
messageExtension: CB-AVALGO
"""
cb_exemption: NotRequired[str]
"""
The exemption indicator returned from Cartes Bancaires in the ARes.
message extension: CB-EXEMPTION; string (4 characters)
This is a 3 byte bitmap (low significant byte first and most significant
bit first) that has been Base64 encoded
"""
cb_score: NotRequired[int]
"""
The risk score returned from Cartes Bancaires in the ARes.
message extension: CB-SCORE; numeric value 0-99
"""
class SetupIntentUpdateParamsPaymentMethodOptionsCardPresent(TypedDict):
pass
class SetupIntentUpdateParamsPaymentMethodOptionsKlarna(TypedDict):
currency: NotRequired[str]
"""
The currency of the SetupIntent. Three letter ISO currency code.
"""
on_demand: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsKlarnaOnDemand"
]
"""
On-demand details if setting up a payment method for on-demand payments.
"""
preferred_locale: NotRequired[
Literal[
"cs-CZ",
"da-DK",
"de-AT",
"de-CH",
"de-DE",
"el-GR",
"en-AT",
"en-AU",
"en-BE",
"en-CA",
"en-CH",
"en-CZ",
"en-DE",
"en-DK",
"en-ES",
"en-FI",
"en-FR",
"en-GB",
"en-GR",
"en-IE",
"en-IT",
"en-NL",
"en-NO",
"en-NZ",
"en-PL",
"en-PT",
"en-RO",
"en-SE",
"en-US",
"es-ES",
"es-US",
"fi-FI",
"fr-BE",
"fr-CA",
"fr-CH",
"fr-FR",
"it-CH",
"it-IT",
"nb-NO",
"nl-BE",
"nl-NL",
"pl-PL",
"pt-PT",
"ro-RO",
"sv-FI",
"sv-SE",
]
]
"""
Preferred language of the Klarna authorization page that the customer is redirected to
"""
subscriptions: NotRequired[
"Literal['']|List[SetupIntentUpdateParamsPaymentMethodOptionsKlarnaSubscription]"
]
"""
Subscription details if setting up or charging a subscription
"""
class SetupIntentUpdateParamsPaymentMethodOptionsKlarnaOnDemand(TypedDict):
average_amount: NotRequired[int]
"""
Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
"""
maximum_amount: NotRequired[int]
"""
The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
"""
minimum_amount: NotRequired[int]
"""
The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
"""
purchase_interval: NotRequired[Literal["day", "month", "week", "year"]]
"""
Interval at which the customer is making purchases
"""
purchase_interval_count: NotRequired[int]
"""
The number of `purchase_interval` between charges
"""
class SetupIntentUpdateParamsPaymentMethodOptionsKlarnaSubscription(TypedDict):
interval: Literal["day", "month", "week", "year"]
"""
Unit of time between subscription charges.
"""
interval_count: NotRequired[int]
"""
The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
"""
name: NotRequired[str]
"""
Name for subscription.
"""
next_billing: "SetupIntentUpdateParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling"
"""
Describes the upcoming charge for this subscription.
"""
reference: str
"""
A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsKlarnaSubscriptionNextBilling(
TypedDict,
):
amount: int
"""
The amount of the next charge for the subscription.
"""
date: str
"""
The date of the next charge for the subscription in YYYY-MM-DD format.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsLink(TypedDict):
persistent_token: NotRequired[str]
"""
[Deprecated] This is a legacy parameter that no longer has any function.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsPaypal(TypedDict):
billing_agreement_id: NotRequired[str]
"""
The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsSepaDebit(TypedDict):
mandate_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsSepaDebitMandateOptions"
]
"""
Additional fields for Mandate creation
"""
class SetupIntentUpdateParamsPaymentMethodOptionsSepaDebitMandateOptions(
TypedDict,
):
reference_prefix: NotRequired["Literal['']|str"]
"""
Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccount(TypedDict):
financial_connections: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountFinancialConnections"
]
"""
Additional fields for Financial Connections Session creation
"""
mandate_options: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountMandateOptions"
]
"""
Additional fields for Mandate creation
"""
networks: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountNetworks"
]
"""
Additional fields for network related functions
"""
verification_method: NotRequired[
Literal["automatic", "instant", "microdeposits"]
]
"""
Bank account verification method.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountFinancialConnections(
TypedDict,
):
filters: NotRequired[
"SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters"
]
"""
Provide filters for the linked accounts that the customer can select for the payment method.
"""
permissions: NotRequired[
List[
Literal["balances", "ownership", "payment_method", "transactions"]
]
]
"""
The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
"""
prefetch: NotRequired[
List[Literal["balances", "ownership", "transactions"]]
]
"""
List of data features that you would like to retrieve upon account creation.
"""
return_url: NotRequired[str]
"""
For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters(
TypedDict,
):
account_subcategories: NotRequired[List[Literal["checking", "savings"]]]
"""
The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountMandateOptions(
TypedDict,
):
collection_method: NotRequired["Literal['']|Literal['paper']"]
"""
The method used to collect offline mandate customer acceptance.
"""
class SetupIntentUpdateParamsPaymentMethodOptionsUsBankAccountNetworks(
TypedDict,
):
requested: NotRequired[List[Literal["ach", "us_domestic_wire"]]]
"""
Triggers validations to run across the selected networks
"""
|