Package com.stripe.model

Class Account

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.Account

All Implemented Interfaces:

HasId, MetadataStore<Account>, PaymentSource, StripeObjectInterface

public class Account
extends ApiResource
implements MetadataStore<Account>, PaymentSource

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

For Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that account has started to go through Connect Onboarding. Once you create an Account Link for a Standard or Express account, some parameters are no longer returned. These are marked as Custom Only or Custom and Express below. Learn about the differences between accounts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Account.BusinessProfile
static class	Account.Capabilities
static class	Account.Company
static class	Account.Controller	Get expanded front.
static class	Account.FutureRequirements	Whether this account has access to the full Stripe dashboard (full), to the Express dashboard (express), or to no dashboard (none).
static class	Account.Requirements	The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
static class	Account.Settings	The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
static class	Account.TosAcceptance	The user agent of the browser from which the account representative accepted the service agreement.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Account()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
CapabilityCollection	capabilities()	Returns a list of capabilities associated with the account.
CapabilityCollection	capabilities(AccountCapabilitiesParams params)	Returns a list of capabilities associated with the account.
CapabilityCollection	capabilities(AccountCapabilitiesParams params, RequestOptions options)	Returns a list of capabilities associated with the account.
CapabilityCollection	capabilities(Map<String,Object> params)	Returns a list of capabilities associated with the account.
CapabilityCollection	capabilities(Map<String,Object> params, RequestOptions options)	Returns a list of capabilities associated with the account.
static Account	create(AccountCreateParams params)	With Connect, you can create Stripe accounts for your users.
static Account	create(AccountCreateParams params, RequestOptions options)	With Connect, you can create Stripe accounts for your users.
static Account	create(Map<String,Object> params)	With Connect, you can create Stripe accounts for your users.
static Account	create(Map<String,Object> params, RequestOptions options)	With Connect, you can create Stripe accounts for your users.
Account	delete()	With Connect, you can delete accounts you manage.
Account	delete(RequestOptions options)	With Connect, you can delete accounts you manage.
Account	delete(Map<String,Object> params)	With Connect, you can delete accounts you manage.
Account	delete(Map<String,Object> params, RequestOptions options)	With Connect, you can delete accounts you manage.
boolean	equals(Object o)
Account.BusinessProfile	getBusinessProfile()	Business information about the account.
String	getBusinessType()	The business type.
Account.Capabilities	getCapabilities()
Boolean	getChargesEnabled()	Whether the account can create live charges.
Account.Company	getCompany()
Account.Controller	getController()
String	getCountry()	The account's country.
Long	getCreated()	Time at which the account was connected.
String	getDefaultCurrency()	Three-letter ISO currency code representing the default currency for the account.
Boolean	getDeleted()	Always true for a deleted object.
Boolean	getDetailsSubmitted()	Whether account details have been submitted.
String	getEmail()	An email address associated with the account.
ExternalAccountCollection	getExternalAccounts()	External accounts (bank accounts and debit cards) currently attached to this account.
Account.FutureRequirements	getFutureRequirements()
String	getId()	Unique identifier for the object.
Person	getIndividual()	This is an object representing a person associated with a Stripe account.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
Boolean	getPayoutsEnabled()	Whether Stripe can send payouts to this account.
Account.Requirements	getRequirements()
Account.Settings	getSettings()	Options for customizing how the account functions within Stripe.
Account.TosAcceptance	getTosAcceptance()
String	getType()	The Stripe account type.
int	hashCode()
static AccountCollection	list(AccountListParams params)	Returns a list of accounts connected to your platform via Connect.
static AccountCollection	list(AccountListParams params, RequestOptions options)	Returns a list of accounts connected to your platform via Connect.
static AccountCollection	list(Map<String,Object> params)	Returns a list of accounts connected to your platform via Connect.
static AccountCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of accounts connected to your platform via Connect.
PersonCollection	persons()	Returns a list of people associated with the account’s legal entity.
PersonCollection	persons(AccountPersonsParams params)	Returns a list of people associated with the account’s legal entity.
PersonCollection	persons(AccountPersonsParams params, RequestOptions options)	Returns a list of people associated with the account’s legal entity.
PersonCollection	persons(Map<String,Object> params)	Returns a list of people associated with the account’s legal entity.
PersonCollection	persons(Map<String,Object> params, RequestOptions options)	Returns a list of people associated with the account’s legal entity.
Account	reject(AccountRejectParams params)	With Connect, you may flag accounts as suspicious.
Account	reject(AccountRejectParams params, RequestOptions options)	With Connect, you may flag accounts as suspicious.
Account	reject(Map<String,Object> params)	With Connect, you may flag accounts as suspicious.
Account	reject(Map<String,Object> params, RequestOptions options)	With Connect, you may flag accounts as suspicious.
static Account	retrieve()	Retrieves the details of an account.
static Account	retrieve(RequestOptions options)	Retrieves the details of an account.
static Account	retrieve(AccountRetrieveParams params, RequestOptions options)	Retrieves the details of an account.
static Account	retrieve(String account)	Retrieves the details of an account.
static Account	retrieve(String account, RequestOptions options)	Retrieves the details of an account.
static Account	retrieve(String account, AccountRetrieveParams params, RequestOptions options)	Retrieves the details of an account.
static Account	retrieve(String account, Map<String,Object> params, RequestOptions options)	Retrieves the details of an account.
static Account	retrieve(Map<String,Object> params, RequestOptions options)	Retrieves the details of an account.
void	setBusinessProfile(Account.BusinessProfile businessProfile)	Business information about the account.
void	setBusinessType(String businessType)	The business type.
void	setCapabilities(Account.Capabilities capabilities)
void	setChargesEnabled(Boolean chargesEnabled)	Whether the account can create live charges.
void	setCompany(Account.Company company)
void	setController(Account.Controller controller)
void	setCountry(String country)	The account's country.
void	setCreated(Long created)	Time at which the account was connected.
void	setDefaultCurrency(String defaultCurrency)	Three-letter ISO currency code representing the default currency for the account.
void	setDeleted(Boolean deleted)	Always true for a deleted object.
void	setDetailsSubmitted(Boolean detailsSubmitted)	Whether account details have been submitted.
void	setEmail(String email)	An email address associated with the account.
void	setExternalAccounts(ExternalAccountCollection externalAccounts)	External accounts (bank accounts and debit cards) currently attached to this account.
void	setFutureRequirements(Account.FutureRequirements futureRequirements)
void	setId(String id)	Unique identifier for the object.
void	setIndividual(Person individual)	This is an object representing a person associated with a Stripe account.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setPayoutsEnabled(Boolean payoutsEnabled)	Whether Stripe can send payouts to this account.
void	setRequirements(Account.Requirements requirements)
void	setSettings(Account.Settings settings)	Options for customizing how the account functions within Stripe.
void	setTosAcceptance(Account.TosAcceptance tosAcceptance)
void	setType(String type)	The Stripe account type.
Account	update(AccountUpdateParams params)	Updates a connected account by setting the values of the parameters passed.
Account	update(AccountUpdateParams params, RequestOptions options)	Updates a connected account by setting the values of the parameters passed.
Account	update(Map<String,Object> params)	Updates a connected account by setting the values of the parameters passed.
Account	update(Map<String,Object> params, RequestOptions options)	Updates a connected account by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeObjectInterface

getLastResponse, setLastResponse

Constructor Details

Account

public Account()

Method Details

capabilities

public CapabilityCollection capabilities()
                                  throws StripeException

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Throws:

StripeException

capabilities

public CapabilityCollection capabilities(Map<String,Object> params)
                                  throws StripeException

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Throws:

StripeException

capabilities

public CapabilityCollection capabilities(Map<String,Object> params,
 RequestOptions options)
                                  throws StripeException

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Throws:

StripeException

capabilities

public CapabilityCollection capabilities(AccountCapabilitiesParams params)
                                  throws StripeException

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Throws:

StripeException

capabilities

public CapabilityCollection capabilities(AccountCapabilitiesParams params,
 RequestOptions options)
                                  throws StripeException

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Throws:

StripeException

create

public static Account create(Map<String,Object> params)
                      throws StripeException

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 pre-fill that information when creating the account. Connect Onboarding won’t ask for the pre-filled information during account onboarding. You can pre-fill any information on the account.

Throws:

StripeException

create

public static Account create(Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

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 pre-fill that information when creating the account. Connect Onboarding won’t ask for the pre-filled information during account onboarding. You can pre-fill any information on the account.

Throws:

StripeException

create

public static Account create(AccountCreateParams params)
                      throws StripeException

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 pre-fill that information when creating the account. Connect Onboarding won’t ask for the pre-filled information during account onboarding. You can pre-fill any information on the account.

Throws:

StripeException

create

public static Account create(AccountCreateParams params,
 RequestOptions options)
                      throws StripeException

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 pre-fill that information when creating the account. Connect Onboarding won’t ask for the pre-filled information during account onboarding. You can pre-fill any information on the account.

Throws:

StripeException

delete

public Account delete()
               throws StripeException

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

Throws:

StripeException

delete

public Account delete(RequestOptions options)
               throws StripeException

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

Throws:

StripeException

delete

public Account delete(Map<String,Object> params)
               throws StripeException

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

Throws:

StripeException

delete

public Account delete(Map<String,Object> params,
 RequestOptions options)
               throws StripeException

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

Throws:

StripeException

list

public static AccountCollection list(Map<String,Object> params)
                              throws StripeException

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

Throws:

StripeException

list

public static AccountCollection list(Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

Throws:

StripeException

list

public static AccountCollection list(AccountListParams params)
                              throws StripeException

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

Throws:

StripeException

list

public static AccountCollection list(AccountListParams params,
 RequestOptions options)
                              throws StripeException

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

Throws:

StripeException

persons

public PersonCollection persons()
                         throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

persons

public PersonCollection persons(Map<String,Object> params)
                         throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

persons

public PersonCollection persons(Map<String,Object> params,
 RequestOptions options)
                         throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

persons

public PersonCollection persons(AccountPersonsParams params)
                         throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

persons

public PersonCollection persons(AccountPersonsParams params,
 RequestOptions options)
                         throws StripeException

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Throws:

StripeException

reject

public Account reject(Map<String,Object> params)
               throws StripeException

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

Throws:

StripeException

reject

public Account reject(Map<String,Object> params,
 RequestOptions options)
               throws StripeException

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

Throws:

StripeException

reject

public Account reject(AccountRejectParams params)
               throws StripeException

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

Throws:

StripeException

reject

public Account reject(AccountRejectParams params,
 RequestOptions options)
               throws StripeException

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

Throws:

StripeException

retrieve

public static Account retrieve()
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

public static Account retrieve(RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

public static Account retrieve(Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

public static Account retrieve(AccountRetrieveParams params,
 RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

public static Account retrieve(String account)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

public static Account retrieve(String account,
 RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

public static Account retrieve(String account,
 Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

public static Account retrieve(String account,
 AccountRetrieveParams params,
 RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

update

public Account update(Map<String,Object> params)
               throws StripeException

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express below.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

Specified by:

update in interface MetadataStore<Account>

Throws:

StripeException

update

public Account update(Map<String,Object> params,
 RequestOptions options)
               throws StripeException

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express below.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

Specified by:

update in interface MetadataStore<Account>

Throws:

StripeException

update

public Account update(AccountUpdateParams params)
               throws StripeException

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express below.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

Throws:

StripeException

update

public Account update(AccountUpdateParams params,
 RequestOptions options)
               throws StripeException

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express below.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

Throws:

StripeException

getBusinessProfile

public Account.BusinessProfile getBusinessProfile()

Business information about the account.

getBusinessType

public String getBusinessType()

The business type.

One of company, government_entity, individual, or non_profit.

getCapabilities

public Account.Capabilities getCapabilities()

getChargesEnabled

public Boolean getChargesEnabled()

Whether the account can create live charges.

getCompany

public Account.Company getCompany()

getController

public Account.Controller getController()

getCountry

public String getCountry()

The account's country.

getCreated

public Long getCreated()

Time at which the account was connected. Measured in seconds since the Unix epoch.

getDefaultCurrency

public String getDefaultCurrency()

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.

getDeleted

public Boolean getDeleted()

Always true for a deleted object.

getDetailsSubmitted

public Boolean getDetailsSubmitted()

Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.

getEmail

public String getEmail()

An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.

getExternalAccounts

public ExternalAccountCollection getExternalAccounts()

External accounts (bank accounts and debit cards) currently attached to this account.

getFutureRequirements

public Account.FutureRequirements getFutureRequirements()

getIndividual

public Person getIndividual()

This is an object representing a person associated with a Stripe account.

A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.

Related guide: Handling Identity Verification with the API.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to account.

getPayoutsEnabled

public Boolean getPayoutsEnabled()

Whether Stripe can send payouts to this account.

getRequirements

public Account.Requirements getRequirements()

getSettings

public Account.Settings getSettings()

Options for customizing how the account functions within Stripe.

getTosAcceptance

public Account.TosAcceptance getTosAcceptance()

getType

public String getType()

The Stripe account type. Can be standard, express, or custom.

setBusinessProfile

public void setBusinessProfile(Account.BusinessProfile businessProfile)

Business information about the account.

setBusinessType

public void setBusinessType(String businessType)

The business type.

One of company, government_entity, individual, or non_profit.

setCapabilities

public void setCapabilities(Account.Capabilities capabilities)

setChargesEnabled

public void setChargesEnabled(Boolean chargesEnabled)

Whether the account can create live charges.

setCompany

public void setCompany(Account.Company company)

setController

public void setController(Account.Controller controller)

setCountry

public void setCountry(String country)

The account's country.

setCreated

public void setCreated(Long created)

Time at which the account was connected. Measured in seconds since the Unix epoch.

setDefaultCurrency

public void setDefaultCurrency(String defaultCurrency)

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.

setDeleted

public void setDeleted(Boolean deleted)

Always true for a deleted object.

setDetailsSubmitted

public void setDetailsSubmitted(Boolean detailsSubmitted)

Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.

setEmail

public void setEmail(String email)

An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.

setExternalAccounts

public void setExternalAccounts(ExternalAccountCollection externalAccounts)

External accounts (bank accounts and debit cards) currently attached to this account.

setFutureRequirements

public void setFutureRequirements(Account.FutureRequirements futureRequirements)

setId

public void setId(String id)

Unique identifier for the object.

setIndividual

public void setIndividual(Person individual)

This is an object representing a person associated with a Stripe account.

A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.

Related guide: Handling Identity Verification with the API.

setMetadata

public void setMetadata(Map<String,String> metadata)

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.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to account.

setPayoutsEnabled

public void setPayoutsEnabled(Boolean payoutsEnabled)

Whether Stripe can send payouts to this account.

setRequirements

public void setRequirements(Account.Requirements requirements)

setSettings

public void setSettings(Account.Settings settings)

Options for customizing how the account functions within Stripe.

setTosAcceptance

public void setTosAcceptance(Account.TosAcceptance tosAcceptance)

setType

public void setType(String type)

The Stripe account type. Can be standard, express, or custom.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,String> getMetadata()

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.

Specified by:

getMetadata in interface MetadataStore<Account>