-
Notifications
You must be signed in to change notification settings - Fork 719
/
AccountsResource.d.ts
3434 lines (2864 loc) · 126 KB
/
AccountsResource.d.ts
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
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
interface AccountCreateParams {
/**
* An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
*/
account_token?: string;
/**
* Business information about the account.
*/
business_profile?: AccountCreateParams.BusinessProfile;
/**
* The business type.
*/
business_type?: AccountCreateParams.BusinessType;
/**
* Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
*/
capabilities?: AccountCreateParams.Capabilities;
/**
* Information about the company or business. This field is available for any `business_type`.
*/
company?: AccountCreateParams.Company;
/**
* The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.
*/
country?: string;
/**
* Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
*/
default_currency?: string;
/**
* Documents that may be submitted to satisfy various informational requests.
*/
documents?: AccountCreateParams.Documents;
/**
* The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent.
*/
email?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.
*
* By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.
*/
external_account?: string | AccountCreateParams.ExternalAccount;
/**
* Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.
*/
individual?: AccountCreateParams.Individual;
/**
* 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`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Options for customizing how the account functions within Stripe.
*/
settings?: AccountCreateParams.Settings;
/**
* Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).
*/
tos_acceptance?: AccountCreateParams.TosAcceptance;
/**
* The type of Stripe account to create. May be one of `custom`, `express` or `standard`.
*/
type?: AccountCreateParams.Type;
}
namespace AccountCreateParams {
interface BusinessProfile {
/**
* [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
*/
mcc?: string;
/**
* The customer-facing business name.
*/
name?: string;
/**
* Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.
*/
product_description?: string;
/**
* A publicly available mailing address for sending support issues to.
*/
support_address?: Stripe.AddressParam;
/**
* A publicly available email address for sending support issues to.
*/
support_email?: string;
/**
* A publicly available phone number to call with support issues.
*/
support_phone?: string;
/**
* A publicly available website for handling support issues.
*/
support_url?: Stripe.Emptyable<string>;
/**
* The business's publicly available website.
*/
url?: string;
}
type BusinessType =
| 'company'
| 'government_entity'
| 'individual'
| 'non_profit';
interface Capabilities {
/**
* The acss_debit_payments capability.
*/
acss_debit_payments?: Capabilities.AcssDebitPayments;
/**
* The affirm_payments capability.
*/
affirm_payments?: Capabilities.AffirmPayments;
/**
* The afterpay_clearpay_payments capability.
*/
afterpay_clearpay_payments?: Capabilities.AfterpayClearpayPayments;
/**
* The au_becs_debit_payments capability.
*/
au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
/**
* The bacs_debit_payments capability.
*/
bacs_debit_payments?: Capabilities.BacsDebitPayments;
/**
* The bancontact_payments capability.
*/
bancontact_payments?: Capabilities.BancontactPayments;
/**
* The bank_transfer_payments capability.
*/
bank_transfer_payments?: Capabilities.BankTransferPayments;
/**
* The blik_payments capability.
*/
blik_payments?: Capabilities.BlikPayments;
/**
* The boleto_payments capability.
*/
boleto_payments?: Capabilities.BoletoPayments;
/**
* The card_issuing capability.
*/
card_issuing?: Capabilities.CardIssuing;
/**
* The card_payments capability.
*/
card_payments?: Capabilities.CardPayments;
/**
* The cartes_bancaires_payments capability.
*/
cartes_bancaires_payments?: Capabilities.CartesBancairesPayments;
/**
* The eps_payments capability.
*/
eps_payments?: Capabilities.EpsPayments;
/**
* The fpx_payments capability.
*/
fpx_payments?: Capabilities.FpxPayments;
/**
* The giropay_payments capability.
*/
giropay_payments?: Capabilities.GiropayPayments;
/**
* The grabpay_payments capability.
*/
grabpay_payments?: Capabilities.GrabpayPayments;
/**
* The ideal_payments capability.
*/
ideal_payments?: Capabilities.IdealPayments;
/**
* The jcb_payments capability.
*/
jcb_payments?: Capabilities.JcbPayments;
/**
* The klarna_payments capability.
*/
klarna_payments?: Capabilities.KlarnaPayments;
/**
* The konbini_payments capability.
*/
konbini_payments?: Capabilities.KonbiniPayments;
/**
* The legacy_payments capability.
*/
legacy_payments?: Capabilities.LegacyPayments;
/**
* The link_payments capability.
*/
link_payments?: Capabilities.LinkPayments;
/**
* The oxxo_payments capability.
*/
oxxo_payments?: Capabilities.OxxoPayments;
/**
* The p24_payments capability.
*/
p24_payments?: Capabilities.P24Payments;
/**
* The paynow_payments capability.
*/
paynow_payments?: Capabilities.PaynowPayments;
/**
* The promptpay_payments capability.
*/
promptpay_payments?: Capabilities.PromptpayPayments;
/**
* The sepa_debit_payments capability.
*/
sepa_debit_payments?: Capabilities.SepaDebitPayments;
/**
* The sofort_payments capability.
*/
sofort_payments?: Capabilities.SofortPayments;
/**
* The tax_reporting_us_1099_k capability.
*/
tax_reporting_us_1099_k?: Capabilities.TaxReportingUs1099K;
/**
* The tax_reporting_us_1099_misc capability.
*/
tax_reporting_us_1099_misc?: Capabilities.TaxReportingUs1099Misc;
/**
* The transfers capability.
*/
transfers?: Capabilities.Transfers;
/**
* The treasury capability.
*/
treasury?: Capabilities.Treasury;
/**
* The us_bank_account_ach_payments capability.
*/
us_bank_account_ach_payments?: Capabilities.UsBankAccountAchPayments;
}
namespace Capabilities {
interface AcssDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AffirmPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AfterpayClearpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AuBecsDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BacsDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BancontactPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BlikPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BoletoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CardIssuing {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CardPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CartesBancairesPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface EpsPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface FpxPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface GiropayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface GrabpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface IdealPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface JcbPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KlarnaPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KonbiniPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface LegacyPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface LinkPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface OxxoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface P24Payments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PaynowPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PromptpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SepaDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SofortPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface TaxReportingUs1099K {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface TaxReportingUs1099Misc {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface Transfers {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface Treasury {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface UsBankAccountAchPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
}
interface Company {
/**
* The company's primary address.
*/
address?: Stripe.AddressParam;
/**
* The Kana variation of the company's primary address (Japan only).
*/
address_kana?: Stripe.JapanAddressParam;
/**
* The Kanji variation of the company's primary address (Japan only).
*/
address_kanji?: Stripe.JapanAddressParam;
/**
* Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
*/
directors_provided?: boolean;
/**
* Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement.
*/
executives_provided?: boolean;
/**
* The company's legal name.
*/
name?: string;
/**
* The Kana variation of the company's legal name (Japan only).
*/
name_kana?: string;
/**
* The Kanji variation of the company's legal name (Japan only).
*/
name_kanji?: string;
/**
* Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement.
*/
owners_provided?: boolean;
/**
* This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
*/
ownership_declaration?: Company.OwnershipDeclaration;
/**
* The company's phone number (used for verification).
*/
phone?: string;
/**
* The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
*/
registration_number?: string;
/**
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.
*/
structure?: Stripe.Emptyable<Company.Structure>;
/**
* The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
*/
tax_id?: string;
/**
* The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
*/
tax_id_registrar?: string;
/**
* The VAT number of the company.
*/
vat_id?: string;
/**
* Information on the verification state of the company.
*/
verification?: Company.Verification;
}
namespace Company {
interface OwnershipDeclaration {
/**
* The Unix timestamp marking when the beneficial owner attestation was made.
*/
date?: number;
/**
* The IP address from which the beneficial owner attestation was made.
*/
ip?: string;
/**
* The user agent of the browser from which the beneficial owner attestation was made.
*/
user_agent?: string;
}
type Structure =
| 'free_zone_establishment'
| 'free_zone_llc'
| 'government_instrumentality'
| 'governmental_unit'
| 'incorporated_non_profit'
| 'limited_liability_partnership'
| 'llc'
| 'multi_member_llc'
| 'private_company'
| 'private_corporation'
| 'private_partnership'
| 'public_company'
| 'public_corporation'
| 'public_partnership'
| 'single_member_llc'
| 'sole_establishment'
| 'sole_proprietorship'
| 'tax_exempt_government_instrumentality'
| 'unincorporated_association'
| 'unincorporated_non_profit';
interface Verification {
/**
* A document verifying the business.
*/
document?: Verification.Document;
}
namespace Verification {
interface Document {
/**
* The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
back?: string;
/**
* The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
front?: string;
}
}
}
interface Documents {
/**
* One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.
*/
bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
/**
* One or more documents that demonstrate proof of a company's license to operate.
*/
company_license?: Documents.CompanyLicense;
/**
* One or more documents showing the company's Memorandum of Association.
*/
company_memorandum_of_association?: Documents.CompanyMemorandumOfAssociation;
/**
* (Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.
*/
company_ministerial_decree?: Documents.CompanyMinisterialDecree;
/**
* One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.
*/
company_registration_verification?: Documents.CompanyRegistrationVerification;
/**
* One or more documents that demonstrate proof of a company's tax ID.
*/
company_tax_id_verification?: Documents.CompanyTaxIdVerification;
/**
* One or more documents showing the company's proof of registration with the national business registry.
*/
proof_of_registration?: Documents.ProofOfRegistration;
}
namespace Documents {
interface BankAccountOwnershipVerification {
/**
* One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyLicense {
/**
* One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyMemorandumOfAssociation {
/**
* One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyMinisterialDecree {
/**
* One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyRegistrationVerification {
/**
* One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyTaxIdVerification {
/**
* One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface ProofOfRegistration {
/**
* One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
}
interface ExternalAccount {
/**
* The type of external account. Should be bank_account.
*/
object: string;
/**
* The country in which the bank account is located.
*/
country: string;
/**
* The currency the bank account is in. This must be a country/currency pairing that [Stripe supports](https://stripe.com/docs/payouts).
*/
currency: string;
/**
* The name of the person or business that owns the bank account. This field is required when attaching the bank account to a Customer object.
*/
account_holder_name?: string;
/**
* The type of entity that holds the account. This can be either individual or company. This field is required when attaching the bank account to a Customer object.
*/
account_holder_type?: string;
/**
* The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for account_number, this field is not required.
*/
routing_number?: string;
/**
* The account number for the bank account, in string form. Must be a checking account.
*/
account_number: string;
}
interface Individual {
/**
* The individual's primary address.
*/
address?: Stripe.AddressParam;
/**
* The Kana variation of the the individual's primary address (Japan only).
*/
address_kana?: Stripe.JapanAddressParam;
/**
* The Kanji variation of the the individual's primary address (Japan only).
*/
address_kanji?: Stripe.JapanAddressParam;
/**
* The individual's date of birth.
*/
dob?: Stripe.Emptyable<Individual.Dob>;
/**
* The individual's email address.
*/
email?: string;
/**
* The individual's first name.
*/
first_name?: string;
/**
* The Kana variation of the the individual's first name (Japan only).
*/
first_name_kana?: string;
/**
* The Kanji variation of the individual's first name (Japan only).
*/
first_name_kanji?: string;
/**
* A list of alternate names or aliases that the individual is known by.
*/
full_name_aliases?: Stripe.Emptyable<Array<string>>;
/**
* The individual's gender (International regulations require either "male" or "female").
*/
gender?: string;
/**
* The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).
*/
id_number?: string;
/**
* The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).
*/
id_number_secondary?: string;
/**
* The individual's last name.
*/
last_name?: string;
/**
* The Kana variation of the individual's last name (Japan only).
*/
last_name_kana?: string;
/**
* The Kanji variation of the individual's last name (Japan only).
*/
last_name_kanji?: string;
/**
* The individual's maiden name.
*/
maiden_name?: string;
/**
* 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`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* The individual's phone number.
*/
phone?: string;
/**
* Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
*/
political_exposure?: Individual.PoliticalExposure;
/**
* The individual's registered address.
*/
registered_address?: Stripe.AddressParam;
/**
* The last four digits of the individual's Social Security Number (U.S. only).
*/
ssn_last_4?: string;
/**
* The individual's verification document information.
*/
verification?: Individual.Verification;
}
namespace Individual {
interface Dob {
/**
* The day of birth, between 1 and 31.
*/
day: number;
/**
* The month of birth, between 1 and 12.
*/
month: number;
/**
* The four-digit year of birth.
*/
year: number;
}
type PoliticalExposure = 'existing' | 'none';
interface Verification {
/**
* A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
*/
additional_document?: Verification.AdditionalDocument;
/**
* An identifying document, either a passport or local ID card.
*/
document?: Verification.Document;
}
namespace Verification {
interface AdditionalDocument {
/**
* The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
back?: string;
/**
* The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
front?: string;
}
interface Document {
/**
* The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
back?: string;
/**
* The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
front?: string;
}
}
}
interface Settings {
/**
* Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.
*/
branding?: Settings.Branding;
/**
* Settings specific to the account's use of the Card Issuing product.
*/
card_issuing?: Settings.CardIssuing;
/**
* Settings specific to card charging on the account.
*/
card_payments?: Settings.CardPayments;
/**
* Settings that apply across payment methods for charging on the account.