forked from stripe/stripe-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
account.go
779 lines (675 loc) · 36.7 KB
/
account.go
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
package stripe
import (
"encoding/json"
"github.com/stripe/stripe-go/v72/form"
)
// AccountType is the type of an account.
type AccountType string
// List of values that AccountType can take.
const (
AccountTypeCustom AccountType = "custom"
AccountTypeExpress AccountType = "express"
AccountTypeStandard AccountType = "standard"
)
// AccountCapability maps to a given capability for an account.
type AccountCapability string
// List of values that AccountCapability can take.
const (
AccountCapabilityAUBECSDebitPayments AccountCapability = "au_becs_debit_payments"
AccountCapabilityBACSDebitPayments AccountCapability = "bacs_debit_payments"
AccountCapabilityBancontactPayments AccountCapability = "bancontact_payments"
AccountCapabilityCardIssuing AccountCapability = "card_issuing"
AccountCapabilityCardPayments AccountCapability = "card_payments"
AccountCapabilityCartesBancairesPayments AccountCapability = "cartes_bancaires_payments"
AccountCapabilityEPSPayments AccountCapability = "eps_payments"
AccountCapabilityFPXPayments AccountCapability = "fpx_payments"
AccountCapabilityGiropayPayments AccountCapability = "giropay_payments"
AccountCapabilityGrabpayPayments AccountCapability = "grabpay_payments"
AccountCapabilityIdealPayments AccountCapability = "ideal_payments"
AccountCapabilityJCBPayments AccountCapability = "jcb_payments"
AccountCapabilityLegacyPayments AccountCapability = "legacy_payments"
AccountCapabilityOXXOPayments AccountCapability = "oxxo_payments"
AccountCapabilityP24Payments AccountCapability = "p24_payments"
AccountCapabilitySEPADebitPayments AccountCapability = "sepa_debit_payments"
AccountCapabilitySofortPayments AccountCapability = "sofort_payments"
AccountCapabilityTaxReportingUS1099K AccountCapability = "tax_reporting_us_1099_k"
AccountCapabilityTaxReportingUS1099MISC AccountCapability = "tax_reporting_us_1099_misc"
AccountCapabilityTransfers AccountCapability = "transfers"
)
// AccountCapabilityStatus is the status a given capability can have
type AccountCapabilityStatus string
// List of values that AccountCapabilityStatus can take.
const (
AccountCapabilityStatusActive AccountCapabilityStatus = "active"
AccountCapabilityStatusInactive AccountCapabilityStatus = "inactive"
AccountCapabilityStatusPending AccountCapabilityStatus = "pending"
)
// ExternalAccountType is the type of an external account.
type ExternalAccountType string
// List of values that ExternalAccountType can take.
const (
ExternalAccountTypeBankAccount ExternalAccountType = "bank_account"
ExternalAccountTypeCard ExternalAccountType = "card"
)
// AccountBusinessType describes the business type associated with an account.
type AccountBusinessType string
// List of values that AccountBusinessType can take.
const (
AccountBusinessTypeCompany AccountBusinessType = "company"
AccountBusinessTypeGovernmentEntity AccountBusinessType = "government_entity"
AccountBusinessTypeIndividual AccountBusinessType = "individual"
AccountBusinessTypeNonProfit AccountBusinessType = "non_profit"
)
// AccountCompanyStructure describes the structure associated with a company.
type AccountCompanyStructure string
// List of values that AccountCompanyStructure can take.
const (
AccountCompanyStructureGovernmentInstrumentality AccountCompanyStructure = "government_instrumentality"
AccountCompanyStructureGovernmentalUnit AccountCompanyStructure = "governmental_unit"
AccountCompanyStructureIncorporatedNonProfit AccountCompanyStructure = "incorporated_non_profit"
AccountCompanyStructureLimitedLiabilityPartnership AccountCompanyStructure = "limited_liability_partnership"
AccountCompanyStructureMultiMemberLLC AccountCompanyStructure = "multi_member_llc"
AccountCompanyStructurePrivateCompany AccountCompanyStructure = "private_company"
AccountCompanyStructurePrivateCorporation AccountCompanyStructure = "private_corporation"
AccountCompanyStructurePrivatePartnership AccountCompanyStructure = "private_partnership"
AccountCompanyStructurePublicCompany AccountCompanyStructure = "public_company"
AccountCompanyStructurePublicCorporation AccountCompanyStructure = "public_corporation"
AccountCompanyStructurePublicPartnership AccountCompanyStructure = "public_partnership"
AccountCompanyStructureSoleProprietorship AccountCompanyStructure = "sole_proprietorship"
AccountCompanyStructureTaxExemptGovernmentInstrumentality AccountCompanyStructure = "tax_exempt_government_instrumentality"
AccountCompanyStructureUnincorporatedAssociation AccountCompanyStructure = "unincorporated_association"
AccountCompanyStructureUnincorporatedNonProfit AccountCompanyStructure = "unincorporated_non_profit"
)
// AccountRequirementsDisabledReason describes why an account is disabled.
type AccountRequirementsDisabledReason string
// List of values that AccountRequirementsDisabledReason can take.
const (
AccountRequirementsDisabledReasonFieldsNeeded AccountRequirementsDisabledReason = "fields_needed"
AccountRequirementsDisabledReasonListed AccountRequirementsDisabledReason = "listed"
AccountRequirementsDisabledReasonOther AccountRequirementsDisabledReason = "other"
AccountRequirementsDisabledReasonRejectedFraud AccountRequirementsDisabledReason = "rejected.fraud"
AccountRequirementsDisabledReasonRejectedListed AccountRequirementsDisabledReason = "rejected.listed"
AccountRequirementsDisabledReasonRejectedOther AccountRequirementsDisabledReason = "rejected.other"
AccountRequirementsDisabledReasonRejectedTermsOfService AccountRequirementsDisabledReason = "rejected.terms_of_service"
AccountRequirementsDisabledReasonUnderReview AccountRequirementsDisabledReason = "under_review"
)
// PayoutInterval describes the payout interval.
type PayoutInterval string
// List of values that PayoutInterval can take.
const (
PayoutIntervalDaily PayoutInterval = "daily"
PayoutIntervalManual PayoutInterval = "manual"
PayoutIntervalMonthly PayoutInterval = "monthly"
PayoutIntervalWeekly PayoutInterval = "weekly"
)
// AccountRejectReason describes the valid reason to reject an account
type AccountRejectReason string
// List of values that AccountRejectReason can take.
const (
AccountRejectReasonFraud AccountRejectReason = "fraud"
AccountRejectReasonOther AccountRejectReason = "other"
AccountRejectReasonTermsOfService AccountRejectReason = "terms_of_service"
)
// AccountCompanyVerificationDocumentDetailsCode is a machine-readable code specifying the
// verification state of a document associated with a company.
type AccountCompanyVerificationDocumentDetailsCode string
// List of values that AccountCompanyVerificationDocumentDetailsCode can take.
const (
AccountCompanyVerificationDocumentDetailsCodeDocumentCorrupt AccountCompanyVerificationDocumentDetailsCode = "document_corrupt"
AccountCompanyVerificationDocumentDetailsCodeDocumentFailedCopy AccountCompanyVerificationDocumentDetailsCode = "document_failed_copy"
AccountCompanyVerificationDocumentDetailsCodeDocumentFailedOther AccountCompanyVerificationDocumentDetailsCode = "document_failed_other"
AccountCompanyVerificationDocumentDetailsCodeDocumentFailedTestMode AccountCompanyVerificationDocumentDetailsCode = "document_failed_test_mode"
AccountCompanyVerificationDocumentDetailsCodeDocumentFraudulent AccountCompanyVerificationDocumentDetailsCode = "document_fraudulent"
AccountCompanyVerificationDocumentDetailsCodeDocumentInvalid AccountCompanyVerificationDocumentDetailsCode = "document_invalid"
AccountCompanyVerificationDocumentDetailsCodeDocumentManipulated AccountCompanyVerificationDocumentDetailsCode = "document_manipulated"
AccountCompanyVerificationDocumentDetailsCodeDocumentNotReadable AccountCompanyVerificationDocumentDetailsCode = "document_not_readable"
AccountCompanyVerificationDocumentDetailsCodeDocumentNotUploaded AccountCompanyVerificationDocumentDetailsCode = "document_not_uploaded"
AccountCompanyVerificationDocumentDetailsCodeDocumentTooLarge AccountCompanyVerificationDocumentDetailsCode = "document_too_large"
)
// AccountTOSAcceptanceServiceAgreement describes the TOS Service agreement of an account
type AccountTOSAcceptanceServiceAgreement string
// List of values that AccountTOSAcceptanceServiceAgreement can take.
const (
AccountTOSAcceptanceServiceAgreementFull AccountTOSAcceptanceServiceAgreement = "full"
AccountTOSAcceptanceServiceAgreementRecipient AccountTOSAcceptanceServiceAgreement = "recipient"
)
// AccountBusinessProfileParams are the parameters allowed for an account's business information
type AccountBusinessProfileParams struct {
MCC *string `form:"mcc"`
Name *string `form:"name"`
ProductDescription *string `form:"product_description"`
SupportAddress *AddressParams `form:"support_address"`
SupportEmail *string `form:"support_email"`
SupportPhone *string `form:"support_phone"`
SupportURL *string `form:"support_url"`
URL *string `form:"url"`
}
// AccountCapabilitiesAUBECSDebitPaymentsParams represent allowed parameters to configure the AU BECS Debit capability on an account.
type AccountCapabilitiesAUBECSDebitPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesBACSDebitPaymentsParams represent allowed parameters to configure the BACS Debit capability on an account.
type AccountCapabilitiesBACSDebitPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesBancontactPaymentsParams represent allowed parameters to configure the bancontact payments capability on an account.
type AccountCapabilitiesBancontactPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesCardIssuingParams represent allowed parameters to configure the Issuing capability on an account.
type AccountCapabilitiesCardIssuingParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesCardPaymentsParams represent allowed parameters to configure the card payments capability on an account.
type AccountCapabilitiesCardPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesCartesBancairesPaymentsParams represent allowed parameters to configure the Cartes Bancaires payments capability on an account.
type AccountCapabilitiesCartesBancairesPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesEPSPaymentsParams represent allowed parameters to configure the EPS payments capability on an account.
type AccountCapabilitiesEPSPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesFPXPaymentsParams represent allowed parameters to configure the FPX payments capability on an account.
type AccountCapabilitiesFPXPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesGiropayPaymentsParams represent allowed parameters to configure the giropay payments capability on an account.
type AccountCapabilitiesGiropayPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesGrabpayPaymentsParams represent allowed parameters to configure the grabpay payments capability on an account.
type AccountCapabilitiesGrabpayPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesIdealPaymentsParams represent allowed parameters to configure the ideal payments capability on an account.
type AccountCapabilitiesIdealPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesJCBPaymentsParams represent allowed parameters to configure the JCB payments capability on an account.
type AccountCapabilitiesJCBPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesLegacyPaymentsParams represent allowed parameters to configure the legacy payments capability on an account.
type AccountCapabilitiesLegacyPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesOXXOPaymentsParams represent allowed parameters to configure the OXXO capability on an account.
type AccountCapabilitiesOXXOPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesP24PaymentsParams represent allowed parameters to configure the P24 payments capability on an account.
type AccountCapabilitiesP24PaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesSEPADebitPaymentsParams represent allowed parameters to configure the SEPA Debit payments capability on an account.
type AccountCapabilitiesSEPADebitPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesSofortPaymentsParams represent allowed parameters to configure the sofort payments capability on an account.
type AccountCapabilitiesSofortPaymentsParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesTaxReportingUS1099KParams represent allowed parameters to configure the 1099-K capability on an account.
type AccountCapabilitiesTaxReportingUS1099KParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesTaxReportingUS1099MISCParams represent allowed parameters to configure the 1099-Misc capability on an account.
type AccountCapabilitiesTaxReportingUS1099MISCParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesTransfersParams represent allowed parameters to configure the transfers capability on an account.
type AccountCapabilitiesTransfersParams struct {
Requested *bool `form:"requested"`
}
// AccountCapabilitiesParams represent allowed parameters to configure capabilities on an account.
type AccountCapabilitiesParams struct {
AUBECSDebitPayments *AccountCapabilitiesAUBECSDebitPaymentsParams `form:"au_becs_debit_payments"`
BACSDebitPayments *AccountCapabilitiesBACSDebitPaymentsParams `form:"bacs_debit_payments"`
BancontactPayments *AccountCapabilitiesBancontactPaymentsParams `form:"bancontact_payments"`
CardIssuing *AccountCapabilitiesCardIssuingParams `form:"card_issuing"`
CardPayments *AccountCapabilitiesCardPaymentsParams `form:"card_payments"`
CartesBancairesPayments *AccountCapabilitiesCartesBancairesPaymentsParams `form:"cartes_bancaires_payments"`
EPSPayments *AccountCapabilitiesEPSPaymentsParams `form:"eps_payments"`
FPXPayments *AccountCapabilitiesFPXPaymentsParams `form:"fpx_payments"`
GiropayPayments *AccountCapabilitiesGiropayPaymentsParams `form:"giropay_payments"`
GrabpayPayments *AccountCapabilitiesGrabpayPaymentsParams `form:"grabpay_payments"`
IdealPayments *AccountCapabilitiesIdealPaymentsParams `form:"ideal_payments"`
JCBPayments *AccountCapabilitiesJCBPaymentsParams `form:"jcb_payments"`
LegacyPayments *AccountCapabilitiesLegacyPaymentsParams `form:"legacy_payments"`
OXXOPayments *AccountCapabilitiesOXXOPaymentsParams `form:"oxxo_payments"`
P24Payments *AccountCapabilitiesP24PaymentsParams `form:"p24_payments"`
SEPADebitPayments *AccountCapabilitiesSEPADebitPaymentsParams `form:"sepa_debit_payments"`
SofortPayments *AccountCapabilitiesSofortPaymentsParams `form:"sofort_payments"`
TaxReportingUS1099K *AccountCapabilitiesTaxReportingUS1099KParams `form:"tax_reporting_us_1099_k"`
TaxReportingUS1099MISC *AccountCapabilitiesTaxReportingUS1099MISCParams `form:"tax_reporting_us_1099_misc"`
Transfers *AccountCapabilitiesTransfersParams `form:"transfers"`
}
// AccountCompanyVerificationDocumentParams are the parameters allowed to pass for a document
// verifying a company.
type AccountCompanyVerificationDocumentParams struct {
Back *string `form:"back"`
Front *string `form:"front"`
}
// AccountCompanyVerificationParams are the parameters allowed to verify a company.
type AccountCompanyVerificationParams struct {
Document *AccountCompanyVerificationDocumentParams `form:"document"`
}
// AccountCompanyParams are the parameters describing the company associated with the account.
type AccountCompanyParams struct {
Address *AccountAddressParams `form:"address"`
AddressKana *AccountAddressParams `form:"address_kana"`
AddressKanji *AccountAddressParams `form:"address_kanji"`
DirectorsProvided *bool `form:"directors_provided"`
ExecutivesProvided *bool `form:"executives_provided"`
Name *string `form:"name"`
NameKana *string `form:"name_kana"`
NameKanji *string `form:"name_kanji"`
OwnersProvided *bool `form:"owners_provided"`
RegistrationNumber *string `form:"registration_number"`
Structure *string `form:"structure"`
Phone *string `form:"phone"`
TaxID *string `form:"tax_id"`
TaxIDRegistrar *string `form:"tax_id_registrar"`
VATID *string `form:"vat_id"`
Verification *AccountCompanyVerificationParams `form:"verification"`
}
// AccountDeclineSettingsParams represents the parameters allowed for configuring
// card declines on connected accounts.
type AccountDeclineSettingsParams struct {
AVSFailure *bool `form:"avs_failure"`
CVCFailure *bool `form:"cvc_failure"`
}
// AccountDocumentsBankAccountOwnershipVerificationParams represents the parameters allowed for passing
// bank account ownership verification documents on an account.
type AccountDocumentsBankAccountOwnershipVerificationParams struct {
Files []*string `form:"files"`
}
// AccountDocumentsParams represents the parameters allowed for passing additional documents on an account.
type AccountDocumentsParams struct {
BankAccountOwnershipVerification *AccountDocumentsBankAccountOwnershipVerificationParams `form:"bank_account_ownership_verification"`
}
// AccountSettingsBrandingParams represent allowed parameters to configure settings specific to the
// account’s branding.
type AccountSettingsBrandingParams struct {
Icon *string `form:"icon"`
Logo *string `form:"logo"`
PrimaryColor *string `form:"primary_color"`
SecondaryColor *string `form:"secondary_color"`
}
// AccountSettingsBACSDebitPaymentsParams represent allowed parameters to configure settings specific to
// BACS Debit charging on the account.
type AccountSettingsBACSDebitPaymentsParams struct {
DisplayName *string `form:"display_name"`
}
// AccountSettingsCardPaymentsParams represent allowed parameters to configure settings specific to
// card charging on the account.
type AccountSettingsCardPaymentsParams struct {
DeclineOn *AccountDeclineSettingsParams `form:"decline_on"`
StatementDescriptorPrefix *string `form:"statement_descriptor_prefix"`
}
// AccountSettingsDashboardParams represent allowed parameters to configure settings for the
// account's Dashboard.
type AccountSettingsDashboardParams struct {
DisplayName *string `form:"display_name"`
Timezone *string `form:"timezone"`
}
// AccountSettingsPaymentsParams represent allowed parameters to configure settings across payment
// methods for charging on the account.
type AccountSettingsPaymentsParams struct {
StatementDescriptor *string `form:"statement_descriptor"`
StatementDescriptorKana *string `form:"statement_descriptor_kana"`
StatementDescriptorKanji *string `form:"statement_descriptor_kanji"`
}
// AccountSettingsPayoutsParams represent allowed parameters to configure settings specific to the
// account’s payouts.
type AccountSettingsPayoutsParams struct {
DebitNegativeBalances *bool `form:"debit_negative_balances"`
Schedule *PayoutScheduleParams `form:"schedule"`
StatementDescriptor *string `form:"statement_descriptor"`
}
// AccountSettingsParams are the parameters allowed for the account's settings.
type AccountSettingsParams struct {
BACSDebitPayments *AccountSettingsBACSDebitPaymentsParams `form:"bacs_debit_payments"`
Branding *AccountSettingsBrandingParams `form:"branding"`
CardPayments *AccountSettingsCardPaymentsParams `form:"card_payments"`
Dashboard *AccountSettingsDashboardParams `form:"dashboard"`
Payments *AccountSettingsPaymentsParams `form:"payments"`
Payouts *AccountSettingsPayoutsParams `form:"payouts"`
}
// PayoutScheduleParams are the parameters allowed for payout schedules.
type PayoutScheduleParams struct {
DelayDays *int64 `form:"delay_days"`
DelayDaysMinimum *bool `form:"-"` // See custom AppendTo
Interval *string `form:"interval"`
MonthlyAnchor *int64 `form:"monthly_anchor"`
WeeklyAnchor *string `form:"weekly_anchor"`
}
// AppendTo implements custom encoding logic for PayoutScheduleParams
// so that we can send a special value for `delay_days` field if needed.
func (p *PayoutScheduleParams) AppendTo(body *form.Values, keyParts []string) {
if BoolValue(p.DelayDaysMinimum) {
body.Add(form.FormatKey(append(keyParts, "delay_days")), "minimum")
}
}
// AccountParams are the parameters allowed during account creation/updates.
type AccountParams struct {
Params `form:"*"`
AccountToken *string `form:"account_token"`
BusinessProfile *AccountBusinessProfileParams `form:"business_profile"`
BusinessType *string `form:"business_type"`
Capabilities *AccountCapabilitiesParams `form:"capabilities"`
Company *AccountCompanyParams `form:"company"`
Country *string `form:"country"`
DefaultCurrency *string `form:"default_currency"`
Documents *AccountDocumentsParams `form:"documents"`
Email *string `form:"email"`
ExternalAccount *AccountExternalAccountParams `form:"external_account"`
Individual *PersonParams `form:"individual"`
Settings *AccountSettingsParams `form:"settings"`
TOSAcceptance *AccountTOSAcceptanceParams `form:"tos_acceptance"`
Type *string `form:"type"`
// This parameter is deprecated. Prefer using Capabilities instead.
RequestedCapabilities []*string `form:"requested_capabilities"`
}
// AccountAddressParams represents an address during account creation/updates.
type AccountAddressParams struct {
City *string `form:"city"`
Country *string `form:"country"`
Line1 *string `form:"line1"`
Line2 *string `form:"line2"`
PostalCode *string `form:"postal_code"`
State *string `form:"state"`
// Town/cho-me. Note that this is only used for Kana/Kanji representations
// of an address.
Town *string `form:"town"`
}
// AccountTOSAcceptanceParams represents tos_acceptance during account creation/updates.
type AccountTOSAcceptanceParams struct {
Date *int64 `form:"date"`
IP *string `form:"ip"`
UserAgent *string `form:"user_agent"`
ServiceAgreement *string `form:"service_agreement"`
}
// AccountListParams are the parameters allowed during account listing.
type AccountListParams struct {
ListParams `form:"*"`
}
// AccountRejectParams is the structure for the Reject function.
type AccountRejectParams struct {
Params `form:"*"`
Reason *string `form:"reason"`
}
// AccountExternalAccountParams are the parameters allowed to reference an
// external account when creating an account. It should either have Token set
// or everything else.
type AccountExternalAccountParams struct {
Params `form:"*"`
AccountNumber *string `form:"account_number"`
AccountHolderName *string `form:"account_holder_name"`
AccountHolderType *string `form:"account_holder_type"`
Country *string `form:"country"`
Currency *string `form:"currency"`
RoutingNumber *string `form:"routing_number"`
Token *string `form:"token"`
}
// AppendTo implements custom encoding logic for AccountExternalAccountParams
// so that we can send the special required `object` field up along with the
// other specified parameters or the token value.
func (p *AccountExternalAccountParams) AppendTo(body *form.Values, keyParts []string) {
if p.Token != nil {
body.Add(form.FormatKey(keyParts), StringValue(p.Token))
} else {
body.Add(form.FormatKey(append(keyParts, "object")), "bank_account")
}
}
// AccountBusinessProfile represents optional information related to the business.
type AccountBusinessProfile struct {
MCC string `json:"mcc"`
Name string `json:"name"`
ProductDescription string `json:"product_description"`
SupportAddress *Address `json:"support_address"`
SupportEmail string `json:"support_email"`
SupportPhone string `json:"support_phone"`
SupportURL string `json:"support_url"`
URL string `json:"url"`
}
// AccountCapabilities is the resource representing the capabilities enabled on that account.
type AccountCapabilities struct {
AUBECSDebitPayments AccountCapabilityStatus `json:"au_becs_debit_payments"`
BACSDebitPayments AccountCapabilityStatus `json:"bacs_debit_payments"`
BancontactPayments AccountCapabilityStatus `json:"bancontact_payments"`
CardIssuing AccountCapabilityStatus `json:"card_issuing"`
CardPayments AccountCapabilityStatus `json:"card_payments"`
CartesBancairesPayments AccountCapabilityStatus `json:"cartes_bancaires_payments"`
EPSPayments AccountCapabilityStatus `json:"eps_payments"`
FPXPayments AccountCapabilityStatus `json:"fpx_payments"`
GiropayPayments AccountCapabilityStatus `json:"giropay_payments"`
GrabpayPayments AccountCapabilityStatus `json:"grabpay_payments"`
IdealPayments AccountCapabilityStatus `json:"ideal_payments"`
JCBPayments AccountCapabilityStatus `json:"jcb_payments"`
LegacyPayments AccountCapabilityStatus `json:"legacy_payments"`
OXXOPayments AccountCapabilityStatus `json:"oxxo_payments"`
P24Payments AccountCapabilityStatus `json:"p24_payments"`
SEPADebitPayments AccountCapabilityStatus `json:"sepa_debit_payments"`
SofortPayments AccountCapabilityStatus `json:"sofort_payments"`
TaxReportingUS1099K AccountCapabilityStatus `json:"tax_reporting_us_1099_k"`
TaxReportingUS1099MISC AccountCapabilityStatus `json:"tax_reporting_us_1099_misc"`
Transfers AccountCapabilityStatus `json:"transfers"`
}
// AccountCompanyVerificationDocument represents details about a company's verification state.
type AccountCompanyVerificationDocument struct {
Back *File `json:"back"`
Details string `json:"details"`
DetailsCode AccountCompanyVerificationDocumentDetailsCode `json:"details_code"`
Front *File `json:"front"`
}
// AccountCompanyVerification represents details about a company's verification state.
type AccountCompanyVerification struct {
Document *AccountCompanyVerificationDocument `json:"document"`
}
// AccountCompany represents details about the company or business associated with the account.
type AccountCompany struct {
Address *AccountAddress `json:"address"`
AddressKana *AccountAddress `json:"address_kana"`
AddressKanji *AccountAddress `json:"address_kanji"`
DirectorsProvided bool `json:"directors_provided"`
ExecutivesProvided bool `json:"executives_provided"`
Name string `json:"name"`
NameKana string `json:"name_kana"`
NameKanji string `json:"name_kanji"`
OwnersProvided bool `json:"owners_provided"`
Phone string `json:"phone"`
RegistrationNumber string `json:"registration_number"`
Structure AccountCompanyStructure `json:"structure"`
TaxIDProvided bool `json:"tax_id_provided"`
TaxIDRegistrar string `json:"tax_id_registrar"`
VATIDProvided bool `json:"vat_id_provided"`
Verification *AccountCompanyVerification `json:"verification"`
}
// AccountDeclineOn represents card charges decline behavior for that account.
type AccountDeclineOn struct {
AVSFailure bool `json:"avs_failure"`
CVCFailure bool `json:"cvc_failure"`
}
// AccountPayoutSchedule is the structure for an account's payout schedule.
type AccountPayoutSchedule struct {
DelayDays int64 `json:"delay_days"`
Interval PayoutInterval `json:"interval"`
MonthlyAnchor int64 `json:"monthly_anchor"`
WeeklyAnchor string `json:"weekly_anchor"`
}
// AccountRequirementsError represents details about an error with a requirement.
type AccountRequirementsError struct {
Code string `json:"code"`
Reason string `json:"reason"`
Requirement string `json:"requirement"`
}
// AccountRequirements represents information that needs to be collected for an account.
type AccountRequirements struct {
CurrentDeadline int64 `json:"current_deadline"`
CurrentlyDue []string `json:"currently_due"`
DisabledReason AccountRequirementsDisabledReason `json:"disabled_reason"`
Errors []*AccountRequirementsError `json:"errors"`
EventuallyDue []string `json:"eventually_due"`
PastDue []string `json:"past_due"`
PendingVerification []string `json:"pending_verification"`
}
// AccountSettingsBACSDebitPayments represents settings specific to the account’s charging
// via BACS Debit.
type AccountSettingsBACSDebitPayments struct {
DisplayName string `json:"display_name"`
}
// AccountSettingsBranding represents settings specific to the account's branding.
type AccountSettingsBranding struct {
Icon *File `json:"icon"`
Logo *File `json:"logo"`
PrimaryColor string `json:"primary_color"`
SecondaryColor string `json:"secondary_color"`
}
// AccountSettingsCardPayments represents settings specific to card charging on the account.
type AccountSettingsCardPayments struct {
DeclineOn *AccountDeclineOn `json:"decline_on"`
StatementDescriptorPrefix string `json:"statement_descriptor_prefix"`
}
// AccountSettingsDashboard represents settings specific to the account's Dashboard.
type AccountSettingsDashboard struct {
DisplayName string `json:"display_name"`
Timezone string `json:"timezone"`
}
// AccountSettingsPayments represents settings that apply across payment methods for charging on
// the account.
type AccountSettingsPayments struct {
StatementDescriptor string `json:"statement_descriptor"`
StatementDescriptorKana string `json:"statement_descriptor_kana"`
StatementDescriptorKanji string `json:"statement_descriptor_kanji"`
}
// AccountSettingsPayouts represents settings specific to the account’s payouts.
type AccountSettingsPayouts struct {
DebitNegativeBalances bool `json:"debit_negative_balances"`
Schedule *AccountPayoutSchedule `json:"schedule"`
StatementDescriptor string `json:"statement_descriptor"`
}
// AccountSettingsSEPADebitPayments represents settings specific to the account’s charging
// via SEPA Debit.
type AccountSettingsSEPADebitPayments struct {
CreditorID string `json:"creditor_id"`
}
// AccountSettings represents options for customizing how the account functions within Stripe.
type AccountSettings struct {
BACSDebitPayments *AccountSettingsBACSDebitPayments `json:"bacs_debit_payments"`
Branding *AccountSettingsBranding `json:"branding"`
CardPayments *AccountSettingsCardPayments `json:"card_payments"`
Dashboard *AccountSettingsDashboard `json:"dashboard"`
Payments *AccountSettingsPayments `json:"payments"`
Payouts *AccountSettingsPayouts `json:"payouts"`
SEPADebitPayments *AccountSettingsSEPADebitPayments `json:"sepa_debit_payments"`
}
// AccountTOSAcceptance represents status of acceptance of our terms of services for the account.
type AccountTOSAcceptance struct {
Date int64 `json:"date"`
IP string `json:"ip"`
UserAgent string `json:"user_agent"`
ServiceAgreement AccountTOSAcceptanceServiceAgreement `json:"service_agreement"`
}
// Account is the resource representing your Stripe account.
// For more details see https://stripe.com/docs/api/#account.
type Account struct {
APIResource
BusinessProfile *AccountBusinessProfile `json:"business_profile"`
BusinessType AccountBusinessType `json:"business_type"`
Capabilities *AccountCapabilities `json:"capabilities"`
ChargesEnabled bool `json:"charges_enabled"`
Company *AccountCompany `json:"company"`
Country string `json:"country"`
Created int64 `json:"created"`
DefaultCurrency Currency `json:"default_currency"`
Deleted bool `json:"deleted"`
DetailsSubmitted bool `json:"details_submitted"`
Email string `json:"email"`
ExternalAccounts *ExternalAccountList `json:"external_accounts"`
ID string `json:"id"`
Individual *Person `json:"individual"`
Metadata map[string]string `json:"metadata"`
Object string `json:"object"`
PayoutsEnabled bool `json:"payouts_enabled"`
Requirements *AccountRequirements `json:"requirements"`
Settings *AccountSettings `json:"settings"`
TOSAcceptance *AccountTOSAcceptance `json:"tos_acceptance"`
Type AccountType `json:"type"`
}
// UnmarshalJSON handles deserialization of an account.
// This custom unmarshaling is needed because the resulting
// property may be an ID or the full struct if it was expanded.
func (a *Account) UnmarshalJSON(data []byte) error {
if id, ok := ParseID(data); ok {
a.ID = id
return nil
}
type account Account
var v account
if err := json.Unmarshal(data, &v); err != nil {
return err
}
*a = Account(v)
return nil
}
// AccountList is a list of accounts as returned from a list endpoint.
type AccountList struct {
APIResource
ListMeta
Data []*Account `json:"data"`
}
// ExternalAccountList is a list of external accounts that may be either bank
// accounts or cards.
type ExternalAccountList struct {
APIResource
ListMeta
// Values contains any external accounts (bank accounts and/or cards)
// currently attached to this account.
Data []*ExternalAccount `json:"data"`
}
// ExternalAccount is an external account (a bank account or card) that's
// attached to an account. It contains fields that will be conditionally
// populated depending on its type.
type ExternalAccount struct {
// BankAccount is a bank account attached to an account. Populated only if
// the external account is a bank account.
BankAccount *BankAccount
// Card is a card attached to an account. Populated only if the external
// account is a card.
Card *Card
ID string `json:"id"`
Type ExternalAccountType `json:"object"`
}
// UnmarshalJSON implements Unmarshaler.UnmarshalJSON.
func (ea *ExternalAccount) UnmarshalJSON(data []byte) error {
type externalAccount ExternalAccount
var v externalAccount
if err := json.Unmarshal(data, &v); err != nil {
return err
}
var err error
*ea = ExternalAccount(v)
switch ea.Type {
case ExternalAccountTypeBankAccount:
err = json.Unmarshal(data, &ea.BankAccount)
case ExternalAccountTypeCard:
err = json.Unmarshal(data, &ea.Card)
}
return err
}
// AccountAddress is the structure for an account address.
type AccountAddress struct {
City string `json:"city"`
Country string `json:"country"`
Line1 string `json:"line1"`
Line2 string `json:"line2"`
PostalCode string `json:"postal_code"`
State string `json:"state"`
// Town/cho-me. Note that this is only used for Kana/Kanji representations
// of an address.
Town string `json:"town"`
}