stripe
Version:
Stripe API wrapper
1,215 lines (1,010 loc) • 198 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
interface AccountCreateParams {
/**
* An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
*/
account_token?: string;
/**
* Business information about the account.
*/
business_profile?: AccountCreateParams.BusinessProfile;
/**
* The business type. 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.
*/
business_type?: AccountCreateParams.BusinessType;
/**
* Each key of the dictionary represents a capability, and each capability
* maps to its settings (for example, whether it has been requested or not). Each
* capability is inactive until you have provided its specific
* requirements and Stripe has verified them. An account might have some
* of its requested capabilities be active and some be inactive.
*
* Required when [account.controller.stripe_dashboard.type](https://docs.stripe.com/api/accounts/create#create_account-controller-dashboard-type)
* is `none`, which includes Custom accounts.
*/
capabilities?: AccountCreateParams.Capabilities;
/**
* 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.
*/
company?: AccountCreateParams.Company;
/**
* A hash of configuration describing the account controller's attributes.
*/
controller?: AccountCreateParams.Controller;
/**
* The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.
*/
country?: string;
/**
* Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).
*/
default_currency?: string;
/**
* Documents that may be submitted to satisfy various informational requests.
*/
documents?: AccountCreateParams.Documents;
/**
* The email address of the account holder. This is only to make the account easier to identify to you. 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.
*/
email?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A card or bank account to attach to the account for receiving [payouts](https://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.
*
* 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.
*/
external_account?: string | AccountCreateParams.ExternalAccount;
/**
* A hash of account group type to tokens. These are account groups this account should be added to.
*/
groups?: AccountCreateParams.Groups;
/**
* 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.
*/
individual?: AccountCreateParams.Individual;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Options for customizing how the account functions within Stripe.
*/
settings?: AccountCreateParams.Settings;
/**
* Details on the account's acceptance of the [Stripe Services Agreement](https://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.
*/
tos_acceptance?: AccountCreateParams.TosAcceptance;
/**
* The type of Stripe account to create. May be one of `custom`, `express` or `standard`.
*/
type?: AccountCreateParams.Type;
}
namespace AccountCreateParams {
interface BusinessProfile {
/**
* The applicant's gross annual revenue for its preceding fiscal year.
*/
annual_revenue?: BusinessProfile.AnnualRevenue;
/**
* An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
*/
estimated_worker_count?: number;
/**
* [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.
*/
mcc?: string;
/**
* Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
*/
minority_owned_business_designation?: Array<
BusinessProfile.MinorityOwnedBusinessDesignation
>;
/**
* An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.
*/
monthly_estimated_revenue?: BusinessProfile.MonthlyEstimatedRevenue;
/**
* The customer-facing business name.
*/
name?: string;
/**
* Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.
*/
product_description?: string;
/**
* A publicly available mailing address for sending support issues to.
*/
support_address?: Stripe.AddressParam;
/**
* A publicly available email address for sending support issues to.
*/
support_email?: string;
/**
* A publicly available phone number to call with support issues.
*/
support_phone?: string;
/**
* A publicly available website for handling support issues.
*/
support_url?: Stripe.Emptyable<string>;
/**
* The business's publicly available website.
*/
url?: string;
}
namespace BusinessProfile {
interface AnnualRevenue {
/**
* A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
*/
amount: number;
/**
* 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).
*/
currency: string;
/**
* The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
*/
fiscal_year_end: string;
}
type MinorityOwnedBusinessDesignation =
| 'lgbtqi_owned_business'
| 'minority_owned_business'
| 'none_of_these_apply'
| 'prefer_not_to_answer'
| 'women_owned_business';
interface MonthlyEstimatedRevenue {
/**
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
*/
amount: number;
/**
* 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).
*/
currency: string;
}
}
type BusinessType =
| 'company'
| 'government_entity'
| 'individual'
| 'non_profit';
interface Capabilities {
/**
* The acss_debit_payments capability.
*/
acss_debit_payments?: Capabilities.AcssDebitPayments;
/**
* The affirm_payments capability.
*/
affirm_payments?: Capabilities.AffirmPayments;
/**
* The afterpay_clearpay_payments capability.
*/
afterpay_clearpay_payments?: Capabilities.AfterpayClearpayPayments;
/**
* The alma_payments capability.
*/
alma_payments?: Capabilities.AlmaPayments;
/**
* The amazon_pay_payments capability.
*/
amazon_pay_payments?: Capabilities.AmazonPayPayments;
/**
* The au_becs_debit_payments capability.
*/
au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
/**
* The bacs_debit_payments capability.
*/
bacs_debit_payments?: Capabilities.BacsDebitPayments;
/**
* The bancontact_payments capability.
*/
bancontact_payments?: Capabilities.BancontactPayments;
/**
* The bank_transfer_payments capability.
*/
bank_transfer_payments?: Capabilities.BankTransferPayments;
/**
* The billie_payments capability.
*/
billie_payments?: Capabilities.BilliePayments;
/**
* The blik_payments capability.
*/
blik_payments?: Capabilities.BlikPayments;
/**
* The boleto_payments capability.
*/
boleto_payments?: Capabilities.BoletoPayments;
/**
* The card_issuing capability.
*/
card_issuing?: Capabilities.CardIssuing;
/**
* The card_payments capability.
*/
card_payments?: Capabilities.CardPayments;
/**
* The cartes_bancaires_payments capability.
*/
cartes_bancaires_payments?: Capabilities.CartesBancairesPayments;
/**
* The cashapp_payments capability.
*/
cashapp_payments?: Capabilities.CashappPayments;
/**
* The crypto_payments capability.
*/
crypto_payments?: Capabilities.CryptoPayments;
/**
* The eps_payments capability.
*/
eps_payments?: Capabilities.EpsPayments;
/**
* The fpx_payments capability.
*/
fpx_payments?: Capabilities.FpxPayments;
/**
* The gb_bank_transfer_payments capability.
*/
gb_bank_transfer_payments?: Capabilities.GbBankTransferPayments;
/**
* The giropay_payments capability.
*/
giropay_payments?: Capabilities.GiropayPayments;
/**
* The grabpay_payments capability.
*/
grabpay_payments?: Capabilities.GrabpayPayments;
/**
* The ideal_payments capability.
*/
ideal_payments?: Capabilities.IdealPayments;
/**
* The india_international_payments capability.
*/
india_international_payments?: Capabilities.IndiaInternationalPayments;
/**
* The jcb_payments capability.
*/
jcb_payments?: Capabilities.JcbPayments;
/**
* The jp_bank_transfer_payments capability.
*/
jp_bank_transfer_payments?: Capabilities.JpBankTransferPayments;
/**
* The kakao_pay_payments capability.
*/
kakao_pay_payments?: Capabilities.KakaoPayPayments;
/**
* The klarna_payments capability.
*/
klarna_payments?: Capabilities.KlarnaPayments;
/**
* The konbini_payments capability.
*/
konbini_payments?: Capabilities.KonbiniPayments;
/**
* The kr_card_payments capability.
*/
kr_card_payments?: Capabilities.KrCardPayments;
/**
* The legacy_payments capability.
*/
legacy_payments?: Capabilities.LegacyPayments;
/**
* The link_payments capability.
*/
link_payments?: Capabilities.LinkPayments;
/**
* The mobilepay_payments capability.
*/
mobilepay_payments?: Capabilities.MobilepayPayments;
/**
* The multibanco_payments capability.
*/
multibanco_payments?: Capabilities.MultibancoPayments;
/**
* The mx_bank_transfer_payments capability.
*/
mx_bank_transfer_payments?: Capabilities.MxBankTransferPayments;
/**
* The naver_pay_payments capability.
*/
naver_pay_payments?: Capabilities.NaverPayPayments;
/**
* The nz_bank_account_becs_debit_payments capability.
*/
nz_bank_account_becs_debit_payments?: Capabilities.NzBankAccountBecsDebitPayments;
/**
* The oxxo_payments capability.
*/
oxxo_payments?: Capabilities.OxxoPayments;
/**
* The p24_payments capability.
*/
p24_payments?: Capabilities.P24Payments;
/**
* The pay_by_bank_payments capability.
*/
pay_by_bank_payments?: Capabilities.PayByBankPayments;
/**
* The payco_payments capability.
*/
payco_payments?: Capabilities.PaycoPayments;
/**
* The paynow_payments capability.
*/
paynow_payments?: Capabilities.PaynowPayments;
/**
* The pix_payments capability.
*/
pix_payments?: Capabilities.PixPayments;
/**
* The promptpay_payments capability.
*/
promptpay_payments?: Capabilities.PromptpayPayments;
/**
* The revolut_pay_payments capability.
*/
revolut_pay_payments?: Capabilities.RevolutPayPayments;
/**
* The samsung_pay_payments capability.
*/
samsung_pay_payments?: Capabilities.SamsungPayPayments;
/**
* The satispay_payments capability.
*/
satispay_payments?: Capabilities.SatispayPayments;
/**
* The sepa_bank_transfer_payments capability.
*/
sepa_bank_transfer_payments?: Capabilities.SepaBankTransferPayments;
/**
* The sepa_debit_payments capability.
*/
sepa_debit_payments?: Capabilities.SepaDebitPayments;
/**
* The sofort_payments capability.
*/
sofort_payments?: Capabilities.SofortPayments;
/**
* The swish_payments capability.
*/
swish_payments?: Capabilities.SwishPayments;
/**
* The tax_reporting_us_1099_k capability.
*/
tax_reporting_us_1099_k?: Capabilities.TaxReportingUs1099K;
/**
* The tax_reporting_us_1099_misc capability.
*/
tax_reporting_us_1099_misc?: Capabilities.TaxReportingUs1099Misc;
/**
* The transfers capability.
*/
transfers?: Capabilities.Transfers;
/**
* The treasury capability.
*/
treasury?: Capabilities.Treasury;
/**
* The twint_payments capability.
*/
twint_payments?: Capabilities.TwintPayments;
/**
* The us_bank_account_ach_payments capability.
*/
us_bank_account_ach_payments?: Capabilities.UsBankAccountAchPayments;
/**
* The us_bank_transfer_payments capability.
*/
us_bank_transfer_payments?: Capabilities.UsBankTransferPayments;
/**
* The zip_payments capability.
*/
zip_payments?: Capabilities.ZipPayments;
}
namespace Capabilities {
interface AcssDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AffirmPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AfterpayClearpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AlmaPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AmazonPayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AuBecsDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BacsDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BancontactPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BilliePayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BlikPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BoletoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CardIssuing {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CardPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CartesBancairesPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CashappPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CryptoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface EpsPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface FpxPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface GbBankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface GiropayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface GrabpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface IdealPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface IndiaInternationalPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface JcbPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface JpBankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KakaoPayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KlarnaPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KonbiniPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KrCardPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface LegacyPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface LinkPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface MobilepayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface MultibancoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface MxBankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface NaverPayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface NzBankAccountBecsDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface OxxoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface P24Payments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PayByBankPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PaycoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PaynowPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PixPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PromptpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface RevolutPayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SamsungPayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SatispayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SepaBankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SepaDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SofortPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SwishPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface TaxReportingUs1099K {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface TaxReportingUs1099Misc {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface Transfers {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface Treasury {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface TwintPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface UsBankAccountAchPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface UsBankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface ZipPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
}
interface Company {
/**
* The company's primary address.
*/
address?: Stripe.AddressParam;
/**
* The Kana variation of the company's primary address (Japan only).
*/
address_kana?: Stripe.JapanAddressParam;
/**
* The Kanji variation of the company's primary address (Japan only).
*/
address_kanji?: Stripe.JapanAddressParam;
/**
* Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://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.
*/
directors_provided?: boolean;
/**
* This hash is used to attest that the directors information provided to Stripe is both current and correct.
*/
directorship_declaration?: Company.DirectorshipDeclaration;
/**
* 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.
*/
executives_provided?: boolean;
/**
* The export license ID number of the company, also referred as Import Export Code (India only).
*/
export_license_id?: string;
/**
* The purpose code to use for export transactions (India only).
*/
export_purpose_code?: string;
/**
* The company's legal name.
*/
name?: string;
/**
* The Kana variation of the company's legal name (Japan only).
*/
name_kana?: string;
/**
* The Kanji variation of the company's legal name (Japan only).
*/
name_kanji?: string;
/**
* Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.
*/
owners_provided?: boolean;
/**
* This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
*/
ownership_declaration?: Company.OwnershipDeclaration;
/**
* This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
*/
ownership_exemption_reason?: Stripe.Emptyable<
Company.OwnershipExemptionReason
>;
/**
* The company's phone number (used for verification).
*/
phone?: string;
/**
* When the business was incorporated or registered.
*/
registration_date?: Stripe.Emptyable<Company.RegistrationDate>;
/**
* The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
*/
registration_number?: string;
/**
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
*/
structure?: Stripe.Emptyable<Company.Structure>;
/**
* The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
*/
tax_id?: string;
/**
* The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
*/
tax_id_registrar?: string;
/**
* The VAT number of the company.
*/
vat_id?: string;
/**
* Information on the verification state of the company.
*/
verification?: Company.Verification;
}
namespace Company {
interface DirectorshipDeclaration {
/**
* The Unix timestamp marking when the directorship declaration attestation was made.
*/
date?: number;
/**
* The IP address from which the directorship declaration attestation was made.
*/
ip?: string;
/**
* The user agent of the browser from which the directorship declaration attestation was made.
*/
user_agent?: string;
}
interface OwnershipDeclaration {
/**
* The Unix timestamp marking when the beneficial owner attestation was made.
*/
date?: number;
/**
* The IP address from which the beneficial owner attestation was made.
*/
ip?: string;
/**
* The user agent of the browser from which the beneficial owner attestation was made.
*/
user_agent?: string;
}
type OwnershipExemptionReason =
| 'qualified_entity_exceeds_ownership_threshold'
| 'qualifies_as_financial_institution';
interface RegistrationDate {
/**
* The day of registration, between 1 and 31.
*/
day: number;
/**
* The month of registration, between 1 and 12.
*/
month: number;
/**
* The four-digit year of registration.
*/
year: number;
}
type Structure =
| 'free_zone_establishment'
| 'free_zone_llc'
| 'government_instrumentality'
| 'governmental_unit'
| 'incorporated_non_profit'
| 'incorporated_partnership'
| 'limited_liability_partnership'
| 'llc'
| 'multi_member_llc'
| 'private_company'
| 'private_corporation'
| 'private_partnership'
| 'public_company'
| 'public_corporation'
| 'public_partnership'
| 'registered_charity'
| 'single_member_llc'
| 'sole_establishment'
| 'sole_proprietorship'
| 'tax_exempt_government_instrumentality'
| 'unincorporated_association'
| 'unincorporated_non_profit'
| 'unincorporated_partnership';
interface Verification {
/**
* A document verifying the business.
*/
document?: Verification.Document;
}
namespace Verification {
interface Document {
/**
* The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
back?: string;
/**
* The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
front?: string;
}
}
}
interface Controller {
/**
* A hash of configuration for who pays Stripe fees for product usage on this account.
*/
fees?: Controller.Fees;
/**
* A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.
*/
losses?: Controller.Losses;
/**
* A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.
*/
requirement_collection?: Controller.RequirementCollection;
/**
* A hash of configuration for Stripe-hosted dashboards.
*/
stripe_dashboard?: Controller.StripeDashboard;
}
namespace Controller {
interface Fees {
/**
* A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
*/
payer?: Fees.Payer;
}
namespace Fees {
type Payer = 'account' | 'application';
}
interface Losses {
/**
* A value indicating who is liable when this account can't pay back negative balances resulting from payments. Defaults to `stripe`.
*/
payments?: Losses.Payments;
}
namespace Losses {
type Payments = 'application' | 'stripe';
}
type RequirementCollection = 'application' | 'stripe';
interface StripeDashboard {
/**
* Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.
*/
type?: StripeDashboard.Type;
}
namespace StripeDashboard {
type Type = 'express' | 'full' | 'none';
}
}
interface Documents {
/**
* One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
*/
bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
/**
* One or more documents that demonstrate proof of a company's license to operate.
*/
company_license?: Documents.CompanyLicense;
/**
* One or more documents showing the company's