stripe 18.1.1 → 18.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +66 -32
- package/OPENAPI_VERSION +1 -1
- package/VERSION +1 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/Invoices.js +4 -0
- package/cjs/resources/Terminal/Readers.js +4 -0
- package/cjs/resources/TestHelpers/Terminal/Readers.js +8 -0
- package/cjs/stripe.core.js +1 -1
- package/esm/apiVersion.js +1 -1
- package/esm/resources/Invoices.js +4 -0
- package/esm/resources/Terminal/Readers.js +4 -0
- package/esm/resources/TestHelpers/Terminal/Readers.js +8 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountSessions.d.ts +65 -0
- package/types/AccountSessionsResource.d.ts +77 -0
- package/types/Accounts.d.ts +22 -15
- package/types/AccountsResource.d.ts +79 -55
- package/types/Balance.d.ts +83 -1
- package/types/BalanceResource.d.ts +1 -1
- package/types/BalanceTransactions.d.ts +10 -0
- package/types/BankAccounts.d.ts +3 -3
- package/types/Billing/Alerts.d.ts +1 -1
- package/types/Billing/AlertsResource.d.ts +2 -2
- package/types/BillingPortal/Sessions.d.ts +1 -1
- package/types/Capabilities.d.ts +1 -1
- package/types/Cards.d.ts +2 -2
- package/types/Charges.d.ts +20 -0
- package/types/ChargesResource.d.ts +4 -4
- package/types/Checkout/Sessions.d.ts +120 -105
- package/types/Checkout/SessionsResource.d.ts +117 -108
- package/types/ConfirmationTokens.d.ts +4 -4
- package/types/CountrySpecs.d.ts +1 -1
- package/types/CreditNotes.d.ts +13 -3
- package/types/CreditNotesResource.d.ts +7 -8
- package/types/CustomerSessions.d.ts +3 -3
- package/types/CustomersResource.d.ts +7 -7
- package/types/Disputes.d.ts +1 -1
- package/types/DisputesResource.d.ts +1 -1
- package/types/EventTypes.d.ts +17 -0
- package/types/Events.d.ts +4 -0
- package/types/Files.d.ts +1 -1
- package/types/FilesResource.d.ts +1 -1
- package/types/Identity/VerificationReports.d.ts +17 -0
- package/types/Identity/VerificationSessions.d.ts +19 -2
- package/types/Identity/VerificationSessionsResource.d.ts +5 -5
- package/types/InvoiceItems.d.ts +1 -1
- package/types/InvoiceLineItems.d.ts +1 -1
- package/types/InvoicePayments.d.ts +9 -2
- package/types/Invoices.d.ts +7 -6
- package/types/InvoicesResource.d.ts +88 -11
- package/types/Issuing/AuthorizationsResource.d.ts +4 -4
- package/types/Issuing/CardsResource.d.ts +3 -0
- package/types/Issuing/DisputesResource.d.ts +2 -2
- package/types/LineItems.d.ts +2 -2
- package/types/PaymentIntents.d.ts +143 -128
- package/types/PaymentIntentsResource.d.ts +492 -441
- package/types/PaymentMethodConfigurations.d.ts +180 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +254 -4
- package/types/PaymentMethodDomainsResource.d.ts +1 -1
- package/types/PaymentMethods.d.ts +4 -4
- package/types/PaymentMethodsResource.d.ts +8 -8
- package/types/Payouts.d.ts +2 -2
- package/types/PayoutsResource.d.ts +2 -2
- package/types/Persons.d.ts +10 -10
- package/types/PlansResource.d.ts +1 -1
- package/types/PricesResource.d.ts +2 -2
- package/types/ProductsResource.d.ts +1 -1
- package/types/PromotionCodesResource.d.ts +1 -1
- package/types/Quotes.d.ts +6 -6
- package/types/Radar/EarlyFraudWarningsResource.d.ts +1 -1
- package/types/Refunds.d.ts +6 -1
- package/types/Reviews.d.ts +1 -1
- package/types/SetupAttempts.d.ts +1 -0
- package/types/SetupIntents.d.ts +2 -1
- package/types/SetupIntentsResource.d.ts +3 -3
- package/types/SourcesResource.d.ts +1 -1
- package/types/SubscriptionItems.d.ts +14 -0
- package/types/SubscriptionItemsResource.d.ts +28 -0
- package/types/SubscriptionSchedules.d.ts +47 -1
- package/types/SubscriptionSchedulesResource.d.ts +99 -3
- package/types/Subscriptions.d.ts +19 -2
- package/types/SubscriptionsResource.d.ts +76 -14
- package/types/Tax/CalculationLineItems.d.ts +5 -0
- package/types/Tax/CalculationsResource.d.ts +5 -0
- package/types/Tax/RegistrationsResource.d.ts +1 -1
- package/types/TaxRates.d.ts +2 -2
- package/types/Terminal/LocationsResource.d.ts +1 -1
- package/types/Terminal/Readers.d.ts +219 -1
- package/types/Terminal/ReadersResource.d.ts +144 -0
- package/types/TestHelpers/Terminal/ReadersResource.d.ts +53 -0
- package/types/Tokens.d.ts +3 -3
- package/types/TokensResource.d.ts +8 -8
- package/types/TransferReversals.d.ts +1 -1
- package/types/TransfersResource.d.ts +2 -2
- package/types/Treasury/ReceivedCredits.d.ts +2 -2
- package/types/WebhookEndpointsResource.d.ts +4 -1
- package/types/lib.d.ts +1 -1
- package/types/test/typescriptTest.ts +3 -3
|
@@ -14,7 +14,7 @@ declare module 'stripe' {
|
|
|
14
14
|
business_profile?: AccountCreateParams.BusinessProfile;
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
|
-
* The business type. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
17
|
+
* The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
18
18
|
*/
|
|
19
19
|
business_type?: AccountCreateParams.BusinessType;
|
|
20
20
|
|
|
@@ -25,13 +25,13 @@ declare module 'stripe' {
|
|
|
25
25
|
* requirements and Stripe has verified them. An account might have some
|
|
26
26
|
* of its requested capabilities be active and some be inactive.
|
|
27
27
|
*
|
|
28
|
-
* Required when [account.controller.stripe_dashboard.type](https://stripe.com/api/accounts/create#create_account-controller-dashboard-type)
|
|
28
|
+
* Required when [account.controller.stripe_dashboard.type](https://docs.stripe.com/api/accounts/create#create_account-controller-dashboard-type)
|
|
29
29
|
* is `none`, which includes Custom accounts.
|
|
30
30
|
*/
|
|
31
31
|
capabilities?: AccountCreateParams.Capabilities;
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
|
-
* Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
34
|
+
* Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
35
35
|
*/
|
|
36
36
|
company?: AccountCreateParams.Company;
|
|
37
37
|
|
|
@@ -56,7 +56,7 @@ declare module 'stripe' {
|
|
|
56
56
|
documents?: AccountCreateParams.Documents;
|
|
57
57
|
|
|
58
58
|
/**
|
|
59
|
-
* The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
|
|
59
|
+
* The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
|
|
60
60
|
*/
|
|
61
61
|
email?: string;
|
|
62
62
|
|
|
@@ -66,9 +66,9 @@ declare module 'stripe' {
|
|
|
66
66
|
expand?: Array<string>;
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
* A card or bank account to attach to the account for receiving [payouts](https://stripe.com/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/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/api#account_create_bank_account) creation.
|
|
69
|
+
* A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/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://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation.
|
|
70
70
|
*
|
|
71
|
-
* 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/api#account_create_bank_account) or [card creation](https://stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
71
|
+
* 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://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
72
72
|
*/
|
|
73
73
|
external_account?: string | AccountCreateParams.ExternalAccount;
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ declare module 'stripe' {
|
|
|
78
78
|
groups?: AccountCreateParams.Groups;
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
|
-
* Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
81
|
+
* Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
82
82
|
*/
|
|
83
83
|
individual?: AccountCreateParams.Individual;
|
|
84
84
|
|
|
@@ -93,7 +93,7 @@ declare module 'stripe' {
|
|
|
93
93
|
settings?: AccountCreateParams.Settings;
|
|
94
94
|
|
|
95
95
|
/**
|
|
96
|
-
* Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
|
|
96
|
+
* Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
|
|
97
97
|
*/
|
|
98
98
|
tos_acceptance?: AccountCreateParams.TosAcceptance;
|
|
99
99
|
|
|
@@ -116,7 +116,7 @@ declare module 'stripe' {
|
|
|
116
116
|
estimated_worker_count?: number;
|
|
117
117
|
|
|
118
118
|
/**
|
|
119
|
-
* [The merchant category code for the account](https://stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
|
|
119
|
+
* [The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
|
|
120
120
|
*/
|
|
121
121
|
mcc?: string;
|
|
122
122
|
|
|
@@ -171,7 +171,7 @@ declare module 'stripe' {
|
|
|
171
171
|
namespace BusinessProfile {
|
|
172
172
|
interface AnnualRevenue {
|
|
173
173
|
/**
|
|
174
|
-
* A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
174
|
+
* A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
175
175
|
*/
|
|
176
176
|
amount: number;
|
|
177
177
|
|
|
@@ -195,7 +195,7 @@ declare module 'stripe' {
|
|
|
195
195
|
|
|
196
196
|
interface MonthlyEstimatedRevenue {
|
|
197
197
|
/**
|
|
198
|
-
* A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
198
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
199
199
|
*/
|
|
200
200
|
amount: number;
|
|
201
201
|
|
|
@@ -418,6 +418,11 @@ declare module 'stripe' {
|
|
|
418
418
|
*/
|
|
419
419
|
paynow_payments?: Capabilities.PaynowPayments;
|
|
420
420
|
|
|
421
|
+
/**
|
|
422
|
+
* The pix_payments capability.
|
|
423
|
+
*/
|
|
424
|
+
pix_payments?: Capabilities.PixPayments;
|
|
425
|
+
|
|
421
426
|
/**
|
|
422
427
|
* The promptpay_payments capability.
|
|
423
428
|
*/
|
|
@@ -787,6 +792,13 @@ declare module 'stripe' {
|
|
|
787
792
|
requested?: boolean;
|
|
788
793
|
}
|
|
789
794
|
|
|
795
|
+
interface PixPayments {
|
|
796
|
+
/**
|
|
797
|
+
* 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.
|
|
798
|
+
*/
|
|
799
|
+
requested?: boolean;
|
|
800
|
+
}
|
|
801
|
+
|
|
790
802
|
interface PromptpayPayments {
|
|
791
803
|
/**
|
|
792
804
|
* 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.
|
|
@@ -917,7 +929,7 @@ declare module 'stripe' {
|
|
|
917
929
|
address_kanji?: Stripe.JapanAddressParam;
|
|
918
930
|
|
|
919
931
|
/**
|
|
920
|
-
* 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/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.
|
|
932
|
+
* 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://docs.stripe.com/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.
|
|
921
933
|
*/
|
|
922
934
|
directors_provided?: boolean;
|
|
923
935
|
|
|
@@ -927,7 +939,7 @@ declare module 'stripe' {
|
|
|
927
939
|
directorship_declaration?: Company.DirectorshipDeclaration;
|
|
928
940
|
|
|
929
941
|
/**
|
|
930
|
-
* 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/api/persons) for accounts with a `relationship.executive` requirement.
|
|
942
|
+
* 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://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.
|
|
931
943
|
*/
|
|
932
944
|
executives_provided?: boolean;
|
|
933
945
|
|
|
@@ -957,7 +969,7 @@ declare module 'stripe' {
|
|
|
957
969
|
name_kanji?: string;
|
|
958
970
|
|
|
959
971
|
/**
|
|
960
|
-
* 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/api/persons) for accounts with a `relationship.owner` requirement.
|
|
972
|
+
* 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://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.
|
|
961
973
|
*/
|
|
962
974
|
owners_provided?: boolean;
|
|
963
975
|
|
|
@@ -986,7 +998,7 @@ declare module 'stripe' {
|
|
|
986
998
|
registration_number?: string;
|
|
987
999
|
|
|
988
1000
|
/**
|
|
989
|
-
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
|
|
1001
|
+
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
|
|
990
1002
|
*/
|
|
991
1003
|
structure?: Stripe.Emptyable<Company.Structure>;
|
|
992
1004
|
|
|
@@ -1369,12 +1381,12 @@ declare module 'stripe' {
|
|
|
1369
1381
|
gender?: string;
|
|
1370
1382
|
|
|
1371
1383
|
/**
|
|
1372
|
-
* 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/js/tokens/create_token?type=pii).
|
|
1384
|
+
* 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://docs.stripe.com/js/tokens/create_token?type=pii).
|
|
1373
1385
|
*/
|
|
1374
1386
|
id_number?: string;
|
|
1375
1387
|
|
|
1376
1388
|
/**
|
|
1377
|
-
* 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/js/tokens/create_token?type=pii).
|
|
1389
|
+
* 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://docs.stripe.com/js/tokens/create_token?type=pii).
|
|
1378
1390
|
*/
|
|
1379
1391
|
id_number_secondary?: string;
|
|
1380
1392
|
|
|
@@ -1594,7 +1606,7 @@ declare module 'stripe' {
|
|
|
1594
1606
|
|
|
1595
1607
|
interface CardIssuing {
|
|
1596
1608
|
/**
|
|
1597
|
-
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/issuing/connect/tos_acceptance).
|
|
1609
|
+
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://docs.stripe.com/issuing/connect/tos_acceptance).
|
|
1598
1610
|
*/
|
|
1599
1611
|
tos_acceptance?: CardIssuing.TosAcceptance;
|
|
1600
1612
|
}
|
|
@@ -1684,12 +1696,12 @@ declare module 'stripe' {
|
|
|
1684
1696
|
|
|
1685
1697
|
interface Payouts {
|
|
1686
1698
|
/**
|
|
1687
|
-
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/connect/account-balances).
|
|
1699
|
+
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances).
|
|
1688
1700
|
*/
|
|
1689
1701
|
debit_negative_balances?: boolean;
|
|
1690
1702
|
|
|
1691
1703
|
/**
|
|
1692
|
-
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/connect/bank-transfers#payout-information) documentation.
|
|
1704
|
+
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.
|
|
1693
1705
|
*/
|
|
1694
1706
|
schedule?: Payouts.Schedule;
|
|
1695
1707
|
|
|
@@ -1702,7 +1714,7 @@ declare module 'stripe' {
|
|
|
1702
1714
|
namespace Payouts {
|
|
1703
1715
|
interface Schedule {
|
|
1704
1716
|
/**
|
|
1705
|
-
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/connect/manage-payout-schedule).
|
|
1717
|
+
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule).
|
|
1706
1718
|
*/
|
|
1707
1719
|
delay_days?: 'minimum' | number;
|
|
1708
1720
|
|
|
@@ -1807,7 +1819,7 @@ declare module 'stripe' {
|
|
|
1807
1819
|
business_profile?: AccountUpdateParams.BusinessProfile;
|
|
1808
1820
|
|
|
1809
1821
|
/**
|
|
1810
|
-
* The business type. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1822
|
+
* The business type. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1811
1823
|
*/
|
|
1812
1824
|
business_type?: AccountUpdateParams.BusinessType;
|
|
1813
1825
|
|
|
@@ -1818,13 +1830,13 @@ declare module 'stripe' {
|
|
|
1818
1830
|
* requirements and Stripe has verified them. An account might have some
|
|
1819
1831
|
* of its requested capabilities be active and some be inactive.
|
|
1820
1832
|
*
|
|
1821
|
-
* Required when [account.controller.stripe_dashboard.type](https://stripe.com/api/accounts/create#create_account-controller-dashboard-type)
|
|
1833
|
+
* Required when [account.controller.stripe_dashboard.type](https://docs.stripe.com/api/accounts/create#create_account-controller-dashboard-type)
|
|
1822
1834
|
* is `none`, which includes Custom accounts.
|
|
1823
1835
|
*/
|
|
1824
1836
|
capabilities?: AccountUpdateParams.Capabilities;
|
|
1825
1837
|
|
|
1826
1838
|
/**
|
|
1827
|
-
* Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1839
|
+
* Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1828
1840
|
*/
|
|
1829
1841
|
company?: AccountUpdateParams.Company;
|
|
1830
1842
|
|
|
@@ -1839,7 +1851,7 @@ declare module 'stripe' {
|
|
|
1839
1851
|
documents?: AccountUpdateParams.Documents;
|
|
1840
1852
|
|
|
1841
1853
|
/**
|
|
1842
|
-
* The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
|
|
1854
|
+
* The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
|
|
1843
1855
|
*/
|
|
1844
1856
|
email?: string;
|
|
1845
1857
|
|
|
@@ -1849,9 +1861,9 @@ declare module 'stripe' {
|
|
|
1849
1861
|
expand?: Array<string>;
|
|
1850
1862
|
|
|
1851
1863
|
/**
|
|
1852
|
-
* A card or bank account to attach to the account for receiving [payouts](https://stripe.com/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/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/api#account_create_bank_account) creation.
|
|
1864
|
+
* A card or bank account to attach to the account for receiving [payouts](https://docs.stripe.com/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://docs.stripe.com/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.stripe.com/api#account_create_bank_account) creation.
|
|
1853
1865
|
*
|
|
1854
|
-
* 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/api#account_create_bank_account) or [card creation](https://stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1866
|
+
* 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://docs.stripe.com/api#account_create_bank_account) or [card creation](https://docs.stripe.com/api#account_create_card) APIs. After you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1855
1867
|
*/
|
|
1856
1868
|
external_account?: Stripe.Emptyable<
|
|
1857
1869
|
| string
|
|
@@ -1866,7 +1878,7 @@ declare module 'stripe' {
|
|
|
1866
1878
|
groups?: AccountUpdateParams.Groups;
|
|
1867
1879
|
|
|
1868
1880
|
/**
|
|
1869
|
-
* Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1881
|
+
* Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
|
|
1870
1882
|
*/
|
|
1871
1883
|
individual?: AccountUpdateParams.Individual;
|
|
1872
1884
|
|
|
@@ -1881,7 +1893,7 @@ declare module 'stripe' {
|
|
|
1881
1893
|
settings?: AccountUpdateParams.Settings;
|
|
1882
1894
|
|
|
1883
1895
|
/**
|
|
1884
|
-
* Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
|
|
1896
|
+
* Details on the account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.
|
|
1885
1897
|
*/
|
|
1886
1898
|
tos_acceptance?: AccountUpdateParams.TosAcceptance;
|
|
1887
1899
|
}
|
|
@@ -1937,7 +1949,7 @@ declare module 'stripe' {
|
|
|
1937
1949
|
estimated_worker_count?: number;
|
|
1938
1950
|
|
|
1939
1951
|
/**
|
|
1940
|
-
* [The merchant category code for the account](https://stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
|
|
1952
|
+
* [The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
|
|
1941
1953
|
*/
|
|
1942
1954
|
mcc?: string;
|
|
1943
1955
|
|
|
@@ -1992,7 +2004,7 @@ declare module 'stripe' {
|
|
|
1992
2004
|
namespace BusinessProfile {
|
|
1993
2005
|
interface AnnualRevenue {
|
|
1994
2006
|
/**
|
|
1995
|
-
* A non-negative integer representing the amount in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
2007
|
+
* A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
1996
2008
|
*/
|
|
1997
2009
|
amount: number;
|
|
1998
2010
|
|
|
@@ -2016,7 +2028,7 @@ declare module 'stripe' {
|
|
|
2016
2028
|
|
|
2017
2029
|
interface MonthlyEstimatedRevenue {
|
|
2018
2030
|
/**
|
|
2019
|
-
* A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/currencies#zero-decimal).
|
|
2031
|
+
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
2020
2032
|
*/
|
|
2021
2033
|
amount: number;
|
|
2022
2034
|
|
|
@@ -2239,6 +2251,11 @@ declare module 'stripe' {
|
|
|
2239
2251
|
*/
|
|
2240
2252
|
paynow_payments?: Capabilities.PaynowPayments;
|
|
2241
2253
|
|
|
2254
|
+
/**
|
|
2255
|
+
* The pix_payments capability.
|
|
2256
|
+
*/
|
|
2257
|
+
pix_payments?: Capabilities.PixPayments;
|
|
2258
|
+
|
|
2242
2259
|
/**
|
|
2243
2260
|
* The promptpay_payments capability.
|
|
2244
2261
|
*/
|
|
@@ -2608,6 +2625,13 @@ declare module 'stripe' {
|
|
|
2608
2625
|
requested?: boolean;
|
|
2609
2626
|
}
|
|
2610
2627
|
|
|
2628
|
+
interface PixPayments {
|
|
2629
|
+
/**
|
|
2630
|
+
* 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.
|
|
2631
|
+
*/
|
|
2632
|
+
requested?: boolean;
|
|
2633
|
+
}
|
|
2634
|
+
|
|
2611
2635
|
interface PromptpayPayments {
|
|
2612
2636
|
/**
|
|
2613
2637
|
* 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.
|
|
@@ -2781,7 +2805,7 @@ declare module 'stripe' {
|
|
|
2781
2805
|
address_kanji?: Stripe.JapanAddressParam;
|
|
2782
2806
|
|
|
2783
2807
|
/**
|
|
2784
|
-
* 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/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.
|
|
2808
|
+
* 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://docs.stripe.com/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.
|
|
2785
2809
|
*/
|
|
2786
2810
|
directors_provided?: boolean;
|
|
2787
2811
|
|
|
@@ -2791,7 +2815,7 @@ declare module 'stripe' {
|
|
|
2791
2815
|
directorship_declaration?: Company.DirectorshipDeclaration;
|
|
2792
2816
|
|
|
2793
2817
|
/**
|
|
2794
|
-
* 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/api/persons) for accounts with a `relationship.executive` requirement.
|
|
2818
|
+
* 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://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.
|
|
2795
2819
|
*/
|
|
2796
2820
|
executives_provided?: boolean;
|
|
2797
2821
|
|
|
@@ -2821,7 +2845,7 @@ declare module 'stripe' {
|
|
|
2821
2845
|
name_kanji?: string;
|
|
2822
2846
|
|
|
2823
2847
|
/**
|
|
2824
|
-
* 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/api/persons) for accounts with a `relationship.owner` requirement.
|
|
2848
|
+
* 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://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.
|
|
2825
2849
|
*/
|
|
2826
2850
|
owners_provided?: boolean;
|
|
2827
2851
|
|
|
@@ -2850,7 +2874,7 @@ declare module 'stripe' {
|
|
|
2850
2874
|
registration_number?: string;
|
|
2851
2875
|
|
|
2852
2876
|
/**
|
|
2853
|
-
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
|
|
2877
|
+
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
|
|
2854
2878
|
*/
|
|
2855
2879
|
structure?: Stripe.Emptyable<Company.Structure>;
|
|
2856
2880
|
|
|
@@ -3137,12 +3161,12 @@ declare module 'stripe' {
|
|
|
3137
3161
|
gender?: string;
|
|
3138
3162
|
|
|
3139
3163
|
/**
|
|
3140
|
-
* 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/js/tokens/create_token?type=pii).
|
|
3164
|
+
* 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://docs.stripe.com/js/tokens/create_token?type=pii).
|
|
3141
3165
|
*/
|
|
3142
3166
|
id_number?: string;
|
|
3143
3167
|
|
|
3144
3168
|
/**
|
|
3145
|
-
* 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/js/tokens/create_token?type=pii).
|
|
3169
|
+
* 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://docs.stripe.com/js/tokens/create_token?type=pii).
|
|
3146
3170
|
*/
|
|
3147
3171
|
id_number_secondary?: string;
|
|
3148
3172
|
|
|
@@ -3362,7 +3386,7 @@ declare module 'stripe' {
|
|
|
3362
3386
|
|
|
3363
3387
|
interface CardIssuing {
|
|
3364
3388
|
/**
|
|
3365
|
-
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/issuing/connect/tos_acceptance).
|
|
3389
|
+
* Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://docs.stripe.com/issuing/connect/tos_acceptance).
|
|
3366
3390
|
*/
|
|
3367
3391
|
tos_acceptance?: CardIssuing.TosAcceptance;
|
|
3368
3392
|
}
|
|
@@ -3457,12 +3481,12 @@ declare module 'stripe' {
|
|
|
3457
3481
|
|
|
3458
3482
|
interface Payouts {
|
|
3459
3483
|
/**
|
|
3460
|
-
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/connect/account-balances).
|
|
3484
|
+
* A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances).
|
|
3461
3485
|
*/
|
|
3462
3486
|
debit_negative_balances?: boolean;
|
|
3463
3487
|
|
|
3464
3488
|
/**
|
|
3465
|
-
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/connect/bank-transfers#payout-information) documentation.
|
|
3489
|
+
* Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.
|
|
3466
3490
|
*/
|
|
3467
3491
|
schedule?: Payouts.Schedule;
|
|
3468
3492
|
|
|
@@ -3475,7 +3499,7 @@ declare module 'stripe' {
|
|
|
3475
3499
|
namespace Payouts {
|
|
3476
3500
|
interface Schedule {
|
|
3477
3501
|
/**
|
|
3478
|
-
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/connect/manage-payout-schedule).
|
|
3502
|
+
* The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule).
|
|
3479
3503
|
*/
|
|
3480
3504
|
delay_days?: 'minimum' | number;
|
|
3481
3505
|
|
|
@@ -4714,10 +4738,10 @@ declare module 'stripe' {
|
|
|
4714
4738
|
|
|
4715
4739
|
class AccountsResource {
|
|
4716
4740
|
/**
|
|
4717
|
-
* With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users.
|
|
4741
|
+
* With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users.
|
|
4718
4742
|
* To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
|
|
4719
4743
|
*
|
|
4720
|
-
* If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when
|
|
4744
|
+
* If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when
|
|
4721
4745
|
* creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
|
|
4722
4746
|
* You can prefill any information on the account.
|
|
4723
4747
|
*/
|
|
@@ -4754,19 +4778,19 @@ declare module 'stripe' {
|
|
|
4754
4778
|
): Promise<Stripe.Response<Stripe.Account>>;
|
|
4755
4779
|
|
|
4756
4780
|
/**
|
|
4757
|
-
* Updates a [connected account](https://stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
|
|
4781
|
+
* Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
|
|
4758
4782
|
* left unchanged.
|
|
4759
4783
|
*
|
|
4760
|
-
* For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
|
|
4784
|
+
* For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
|
|
4761
4785
|
* is application, which includes Custom accounts, you can update any information on the account.
|
|
4762
4786
|
*
|
|
4763
|
-
* For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
|
|
4787
|
+
* For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
|
|
4764
4788
|
* is stripe, which includes Standard and Express accounts, you can update all information until you create
|
|
4765
|
-
* an [Account Link or <a href="/api/account_sessions">Account Session](https://stripe.com/api/account_links) to start Connect onboarding,
|
|
4789
|
+
* an [Account Link or <a href="/api/account_sessions">Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding,
|
|
4766
4790
|
* after which some properties can no longer be updated.
|
|
4767
4791
|
*
|
|
4768
4792
|
* To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
|
|
4769
|
-
* [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
|
|
4793
|
+
* [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
|
|
4770
4794
|
*/
|
|
4771
4795
|
update(
|
|
4772
4796
|
id: string,
|
|
@@ -4775,7 +4799,7 @@ declare module 'stripe' {
|
|
|
4775
4799
|
): Promise<Stripe.Response<Stripe.Account>>;
|
|
4776
4800
|
|
|
4777
4801
|
/**
|
|
4778
|
-
* Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty.
|
|
4802
|
+
* Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty.
|
|
4779
4803
|
*/
|
|
4780
4804
|
list(
|
|
4781
4805
|
params?: AccountListParams,
|
|
@@ -4784,11 +4808,11 @@ declare module 'stripe' {
|
|
|
4784
4808
|
list(options?: RequestOptions): ApiListPromise<Stripe.Account>;
|
|
4785
4809
|
|
|
4786
4810
|
/**
|
|
4787
|
-
* With [Connect](https://stripe.com/connect), you can delete accounts you manage.
|
|
4811
|
+
* With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage.
|
|
4788
4812
|
*
|
|
4789
4813
|
* Test-mode accounts can be deleted at any time.
|
|
4790
4814
|
*
|
|
4791
|
-
* Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero.
|
|
4815
|
+
* Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero.
|
|
4792
4816
|
*
|
|
4793
4817
|
* If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
|
|
4794
4818
|
*/
|
|
@@ -4814,7 +4838,7 @@ declare module 'stripe' {
|
|
|
4814
4838
|
/**
|
|
4815
4839
|
* Creates a login link for a connected account to access the Express Dashboard.
|
|
4816
4840
|
*
|
|
4817
|
-
* You can only create login links for accounts that use the [Express Dashboard](https://stripe.com/connect/express-dashboard) and are connected to your platform.
|
|
4841
|
+
* You can only create login links for accounts that use the [Express Dashboard](https://docs.stripe.com/connect/express-dashboard) and are connected to your platform.
|
|
4818
4842
|
*/
|
|
4819
4843
|
createLoginLink(
|
|
4820
4844
|
id: string,
|
|
@@ -4909,7 +4933,7 @@ declare module 'stripe' {
|
|
|
4909
4933
|
): ApiListPromise<Stripe.Person>;
|
|
4910
4934
|
|
|
4911
4935
|
/**
|
|
4912
|
-
* With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious.
|
|
4936
|
+
* With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.
|
|
4913
4937
|
*
|
|
4914
4938
|
* Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
|
|
4915
4939
|
*/
|
|
@@ -4995,7 +5019,7 @@ declare module 'stripe' {
|
|
|
4995
5019
|
* a connected account and optionally sets it as the default for its currency. Other bank account
|
|
4996
5020
|
* details are not editable by design.
|
|
4997
5021
|
*
|
|
4998
|
-
* You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection).
|
|
5022
|
+
* You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
|
|
4999
5023
|
*
|
|
5000
5024
|
* You can re-enable a disabled bank account by performing an update call without providing any
|
|
5001
5025
|
* arguments or changes.
|
package/types/Balance.d.ts
CHANGED
|
@@ -27,7 +27,7 @@ declare module 'stripe' {
|
|
|
27
27
|
available: Array<Balance.Available>;
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
|
|
30
|
+
* Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
|
|
31
31
|
*/
|
|
32
32
|
connect_reserved?: Array<Balance.ConnectReserved>;
|
|
33
33
|
|
|
@@ -47,6 +47,8 @@ declare module 'stripe' {
|
|
|
47
47
|
* Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.
|
|
48
48
|
*/
|
|
49
49
|
pending: Array<Balance.Pending>;
|
|
50
|
+
|
|
51
|
+
refund_and_dispute_prefunding?: Balance.RefundAndDisputePrefunding;
|
|
50
52
|
}
|
|
51
53
|
|
|
52
54
|
namespace Balance {
|
|
@@ -261,6 +263,86 @@ declare module 'stripe' {
|
|
|
261
263
|
fpx?: number;
|
|
262
264
|
}
|
|
263
265
|
}
|
|
266
|
+
|
|
267
|
+
interface RefundAndDisputePrefunding {
|
|
268
|
+
/**
|
|
269
|
+
* Funds that are available for use.
|
|
270
|
+
*/
|
|
271
|
+
available: Array<RefundAndDisputePrefunding.Available>;
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Funds that are pending
|
|
275
|
+
*/
|
|
276
|
+
pending: Array<RefundAndDisputePrefunding.Pending>;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
namespace RefundAndDisputePrefunding {
|
|
280
|
+
interface Available {
|
|
281
|
+
/**
|
|
282
|
+
* Balance amount.
|
|
283
|
+
*/
|
|
284
|
+
amount: number;
|
|
285
|
+
|
|
286
|
+
/**
|
|
287
|
+
* 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).
|
|
288
|
+
*/
|
|
289
|
+
currency: string;
|
|
290
|
+
|
|
291
|
+
source_types?: Available.SourceTypes;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
namespace Available {
|
|
295
|
+
interface SourceTypes {
|
|
296
|
+
/**
|
|
297
|
+
* Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
|
|
298
|
+
*/
|
|
299
|
+
bank_account?: number;
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
|
|
303
|
+
*/
|
|
304
|
+
card?: number;
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
|
|
308
|
+
*/
|
|
309
|
+
fpx?: number;
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
interface Pending {
|
|
314
|
+
/**
|
|
315
|
+
* Balance amount.
|
|
316
|
+
*/
|
|
317
|
+
amount: number;
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* 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).
|
|
321
|
+
*/
|
|
322
|
+
currency: string;
|
|
323
|
+
|
|
324
|
+
source_types?: Pending.SourceTypes;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
namespace Pending {
|
|
328
|
+
interface SourceTypes {
|
|
329
|
+
/**
|
|
330
|
+
* Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
|
|
331
|
+
*/
|
|
332
|
+
bank_account?: number;
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
|
|
336
|
+
*/
|
|
337
|
+
card?: number;
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
|
|
341
|
+
*/
|
|
342
|
+
fpx?: number;
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
}
|
|
264
346
|
}
|
|
265
347
|
}
|
|
266
348
|
}
|
|
@@ -12,7 +12,7 @@ declare module 'stripe' {
|
|
|
12
12
|
class BalanceResource {
|
|
13
13
|
/**
|
|
14
14
|
* Retrieves the current account balance, based on the authentication that was used to make the request.
|
|
15
|
-
* For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
|
|
15
|
+
* For a sample request, see [Accounting for negative balances](https://docs.stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
|
|
16
16
|
*/
|
|
17
17
|
retrieve(
|
|
18
18
|
params?: BalanceRetrieveParams,
|
|
@@ -29,6 +29,11 @@ declare module 'stripe' {
|
|
|
29
29
|
*/
|
|
30
30
|
available_on: number;
|
|
31
31
|
|
|
32
|
+
/**
|
|
33
|
+
* The balance that this transaction impacts.
|
|
34
|
+
*/
|
|
35
|
+
balance_type: BalanceTransaction.BalanceType;
|
|
36
|
+
|
|
32
37
|
/**
|
|
33
38
|
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
34
39
|
*/
|
|
@@ -86,6 +91,11 @@ declare module 'stripe' {
|
|
|
86
91
|
}
|
|
87
92
|
|
|
88
93
|
namespace BalanceTransaction {
|
|
94
|
+
type BalanceType =
|
|
95
|
+
| 'issuing'
|
|
96
|
+
| 'payments'
|
|
97
|
+
| 'refund_and_dispute_prefunding';
|
|
98
|
+
|
|
89
99
|
interface FeeDetail {
|
|
90
100
|
/**
|
|
91
101
|
* Amount of the fee, in cents.
|