pub struct CreateAccount { /* private fields */ }
Expand description
With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.
If you’ve already collected information for your connected accounts, you can prefill that information when. creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.
Implementations§
Source§impl CreateAccount
impl CreateAccount
Sourcepub fn account_token(self, account_token: impl Into<String>) -> Self
pub fn account_token(self, account_token: impl Into<String>) -> Self
An account token, used to securely provide details to the account.
Sourcepub fn business_profile(
self,
business_profile: impl Into<CreateAccountBusinessProfile>,
) -> Self
pub fn business_profile( self, business_profile: impl Into<CreateAccountBusinessProfile>, ) -> Self
Business information about the account.
Sourcepub fn business_type(
self,
business_type: impl Into<AccountBusinessType>,
) -> Self
pub fn business_type( self, business_type: impl Into<AccountBusinessType>, ) -> Self
The business type.
Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
Sourcepub fn capabilities(self, capabilities: impl Into<CapabilitiesParam>) -> Self
pub fn capabilities(self, capabilities: impl Into<CapabilitiesParam>) -> Self
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.
is none
, which includes Custom accounts.
Sourcepub fn company(self, company: impl Into<CreateAccountCompany>) -> Self
pub fn company(self, company: impl Into<CreateAccountCompany>) -> Self
Information about the company or business.
This field is available for any business_type
.
Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
Sourcepub fn controller(self, controller: impl Into<CreateAccountController>) -> Self
pub fn controller(self, controller: impl Into<CreateAccountController>) -> Self
A hash of configuration describing the account controller’s attributes.
Sourcepub fn country(self, country: impl Into<String>) -> Self
pub fn country(self, country: impl Into<String>) -> Self
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 as well as countries where cross-border payouts are supported.
Sourcepub fn default_currency(self, default_currency: impl Into<Currency>) -> Self
pub fn default_currency(self, default_currency: impl Into<Currency>) -> Self
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.
Sourcepub fn documents(self, documents: impl Into<CreateAccountDocuments>) -> Self
pub fn documents(self, documents: impl Into<CreateAccountDocuments>) -> Self
Documents that may be submitted to satisfy various informational requests.
Sourcepub fn email(self, email: impl Into<String>) -> Self
pub fn email(self, email: impl Into<String>) -> Self
The email address of the account holder.
This is only to make the account easier to identify to you.
If controller.requirement_collection is application
, which includes Custom accounts, Stripe doesn’t email the account without your consent.
Sourcepub fn expand(self, expand: impl Into<Vec<String>>) -> Self
pub fn expand(self, expand: impl Into<Vec<String>>) -> Self
Specifies which fields in the response should be expanded.
Sourcepub fn external_account(self, external_account: impl Into<String>) -> Self
pub fn external_account(self, external_account: impl Into<String>) -> Self
A card or bank account to attach to the account for receiving 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, or a dictionary, as documented in the external_account
parameter for 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 or card creation APIs.
After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
Sourcepub fn groups(self, groups: impl Into<AccountGroupsSpecs>) -> Self
pub fn groups(self, groups: impl Into<AccountGroupsSpecs>) -> Self
A hash of account group type to tokens. These are account groups this account should be added to.
Sourcepub fn individual(self, individual: impl Into<CreateAccountIndividual>) -> Self
pub fn individual(self, individual: impl Into<CreateAccountIndividual>) -> Self
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 or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
Sourcepub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self
pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self
Set of key-value pairs 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
.
Sourcepub fn settings(self, settings: impl Into<CreateAccountSettings>) -> Self
pub fn settings(self, settings: impl Into<CreateAccountSettings>) -> Self
Options for customizing how the account functions within Stripe.
Sourcepub fn tos_acceptance(
self,
tos_acceptance: impl Into<TosAcceptanceSpecs>,
) -> Self
pub fn tos_acceptance( self, tos_acceptance: impl Into<TosAcceptanceSpecs>, ) -> Self
Details on the account’s acceptance of the Stripe Services Agreement.
This property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
This property defaults to a full
service agreement when empty.
Sourcepub fn type_(self, type_: impl Into<CreateAccountType>) -> Self
pub fn type_(self, type_: impl Into<CreateAccountType>) -> Self
The type of Stripe account to create. May be one of custom
, express
or standard
.
Source§impl CreateAccount
impl CreateAccount
Sourcepub async fn send<C: StripeClient>(
&self,
client: &C,
) -> Result<<Self as StripeRequest>::Output, C::Err>
pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>
Send the request and return the deserialized response.
Sourcepub fn send_blocking<C: StripeBlockingClient>(
&self,
client: &C,
) -> Result<<Self as StripeRequest>::Output, C::Err>
pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>
Send the request and return the deserialized response, blocking until completion.
Trait Implementations§
Source§impl Clone for CreateAccount
impl Clone for CreateAccount
Source§fn clone(&self) -> CreateAccount
fn clone(&self) -> CreateAccount
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more