Class Account
- All Implemented Interfaces:
HasId
,MetadataStore<Account>
,PaymentSource
,StripeActiveObject
,StripeObjectInterface
For accounts where controller.requirement_collection
is application
, which includes Custom accounts, the properties below are always returned.
For accounts where controller.requirement_collection
is stripe
, which includes Standard and Express accounts, some properties are only
returned until you create an Account Link or
Account Session to start Connect
Onboarding. Learn about the differences between
accounts.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
Three-letter ISO currency code, in lowercase.static class
static class
Get expandedfront
.static class
A value indicating the Stripe dashboard this account has access to independent of the Connect application.static class
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.static class
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.static class
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, INTERNAL_GSON
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Returns a list of capabilities associated with the account.Returns a list of capabilities associated with the account.capabilities
(AccountCapabilitiesParams params, RequestOptions options) Returns a list of capabilities associated with the account.capabilities
(Map<String, Object> params) Returns a list of capabilities associated with the account.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
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.delete()
With Connect, you can delete accounts you manage.delete
(RequestOptions options) With Connect, you can delete accounts you manage.With Connect, you can delete accounts you manage.delete
(Map<String, Object> params, RequestOptions options) With Connect, you can delete accounts you manage.boolean
Business information about the account.The business type.Whether the account can create live charges.The account's country.Time at which the account was connected.Three-letter ISO currency code representing the default currency for the account.Always true for a deleted object.Whether account details have been submitted.getEmail()
An email address associated with the account.External accounts (bank accounts and debit cards) currently attached to this account.getId()
Unique identifier for the object.This is an object representing a person associated with a Stripe account.Set of key-value pairs that you can attach to an object.String representing the object's type.Whether Stripe can send payouts to this account.Options for customizing how the account functions within Stripe.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
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.persons()
Returns a list of people associated with the account’s legal entity.persons
(AccountPersonsParams params) Returns a list of people associated with the account’s legal entity.persons
(AccountPersonsParams params, RequestOptions options) Returns a list of people associated with the account’s legal entity.Returns a list of people associated with the account’s legal entity.persons
(Map<String, Object> params, RequestOptions options) Returns a list of people associated with the account’s legal entity.reject
(AccountRejectParams params) With Connect, you can reject accounts that you have flagged as suspicious.reject
(AccountRejectParams params, RequestOptions options) With Connect, you can reject accounts that you have flagged as suspicious.With Connect, you can reject accounts that you have flagged as suspicious.reject
(Map<String, Object> params, RequestOptions options) With Connect, you can reject accounts that you have flagged 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
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
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
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
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
String representing the object's type.void
setPayoutsEnabled
(Boolean payoutsEnabled) Whether Stripe can send payouts to this account.void
setRequirements
(Account.Requirements requirements) void
setResponseGetter
(StripeResponseGetter responseGetter) Method is used by the containing object orStripeResponseGetter
implementations to set theStripeResponseGetter
instance used to make further requests.void
setSettings
(Account.Settings settings) Options for customizing how the account functions within Stripe.void
setTosAcceptance
(Account.TosAcceptance tosAcceptance) void
The Stripe account type.update
(AccountUpdateParams params) Updates a connected account by setting the values of the parameters passed.update
(AccountUpdateParams params, RequestOptions options) Updates a connected account by setting the values of the parameters passed.Updates a connected account by setting the values of the parameters passed.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, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, 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.StripeActiveObject
trySetResponseGetter
Methods inherited from interface com.stripe.model.StripeObjectInterface
getLastResponse, setLastResponse
-
Constructor Details
-
Account
public Account()
-
-
Method Details
-
capabilities
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
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 StripeExceptionReturns 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
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
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.
- Throws:
StripeException
-
create
public static Account create(Map<String, Object> params, RequestOptions options) throws StripeExceptionWith 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.
- Throws:
StripeException
-
create
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.
- 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 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.
- Throws:
StripeException
-
delete
With Connect, you can delete accounts you manage.Test-mode accounts can be deleted at any time.
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 are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
- Throws:
StripeException
-
delete
With Connect, you can delete accounts you manage.Test-mode accounts can be deleted at any time.
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 are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
- Throws:
StripeException
-
delete
With Connect, you can delete accounts you manage.Test-mode accounts can be deleted at any time.
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 are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
- Throws:
StripeException
-
delete
With Connect, you can delete accounts you manage.Test-mode accounts can be deleted at any time.
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 are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
- Throws:
StripeException
-
list
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 StripeExceptionReturns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.- Throws:
StripeException
-
list
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
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
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 StripeExceptionReturns 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
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
With Connect, you can reject accounts that you have flagged as suspicious.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.
- Throws:
StripeException
-
reject
With Connect, you can reject accounts that you have flagged as suspicious.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.
- Throws:
StripeException
-
reject
With Connect, you can reject accounts that you have flagged as suspicious.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.
- Throws:
StripeException
-
reject
With Connect, you can reject accounts that you have flagged as suspicious.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.
- Throws:
StripeException
-
retrieve
Retrieves the details of an account.- Throws:
StripeException
-
retrieve
Retrieves the details of an account.- Throws:
StripeException
-
retrieve
public static Account retrieve(String account, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves 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
-
retrieve
Retrieves the details of an account.- Throws:
StripeException
-
retrieve
Retrieves the details of an account.- Throws:
StripeException
-
retrieve
public static Account retrieve(Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves 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
-
update
Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.For accounts where controller.requirement_collection is
application
, which includes Custom accounts, you can update any information on the account.For accounts where controller.requirement_collection is
stripe
, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
- Specified by:
update
in interfaceMetadataStore<Account>
- Throws:
StripeException
-
update
Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.For accounts where controller.requirement_collection is
application
, which includes Custom accounts, you can update any information on the account.For accounts where controller.requirement_collection is
stripe
, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
- Specified by:
update
in interfaceMetadataStore<Account>
- Throws:
StripeException
-
update
Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.For accounts where controller.requirement_collection is
application
, which includes Custom accounts, you can update any information on the account.For accounts where controller.requirement_collection is
stripe
, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
- Throws:
StripeException
-
update
Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.For accounts where controller.requirement_collection is
application
, which includes Custom accounts, you can update any information on the account.For accounts where controller.requirement_collection is
stripe
, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
- Throws:
StripeException
-
setResponseGetter
Description copied from interface:StripeActiveObject
Method is used by the containing object orStripeResponseGetter
implementations to set theStripeResponseGetter
instance used to make further requests.- Specified by:
setResponseGetter
in interfaceStripeActiveObject
- Overrides:
setResponseGetter
in classApiResource
- Parameters:
responseGetter
- theStripeResponseGetter
instance to use for making further requests.
-
getBusinessProfile
Business information about the account. -
getBusinessType
The business type. After you create an Account Link or Account Session, this property is only returned for accounts where controller.requirement_collection isapplication
, which includes Custom accounts.One of
company
,government_entity
,individual
, ornon_profit
. -
getCapabilities
-
getChargesEnabled
Whether the account can create live charges. -
getCompany
-
getController
-
getCountry
The account's country. -
getCreated
Time at which the account was connected. Measured in seconds since the Unix epoch. -
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
Always true for a deleted object. -
getDetailsSubmitted
Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details. -
getEmail
An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. -
getExternalAccounts
External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests wherecontroller[is_controller]
is true. -
getFutureRequirements
-
getIndividual
This is an object representing a person associated with a Stripe account.A platform cannot access a person for an account where account.controller.requirement_collection is
stripe
, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.
-
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
account
. -
getPayoutsEnabled
Whether Stripe can send payouts to this account. -
getRequirements
-
getSettings
Options for customizing how the account functions within Stripe. -
getTosAcceptance
-
getType
The Stripe account type. Can bestandard
,express
,custom
, ornone
. -
setBusinessProfile
Business information about the account. -
setBusinessType
The business type. After you create an Account Link or Account Session, this property is only returned for accounts where controller.requirement_collection isapplication
, which includes Custom accounts.One of
company
,government_entity
,individual
, ornon_profit
. -
setCapabilities
-
setChargesEnabled
Whether the account can create live charges. -
setCompany
-
setController
-
setCountry
The account's country. -
setCreated
Time at which the account was connected. Measured in seconds since the Unix epoch. -
setDefaultCurrency
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
Always true for a deleted object. -
setDetailsSubmitted
Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details. -
setEmail
An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. -
setExternalAccounts
External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests wherecontroller[is_controller]
is true. -
setFutureRequirements
-
setId
Unique identifier for the object. -
setIndividual
This is an object representing a person associated with a Stripe account.A platform cannot access a person for an account where account.controller.requirement_collection is
stripe
, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.
-
setMetadata
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
String representing the object's type. Objects of the same type share the same value.Equal to
account
. -
setPayoutsEnabled
Whether Stripe can send payouts to this account. -
setRequirements
-
setSettings
Options for customizing how the account functions within Stripe. -
setTosAcceptance
-
setType
The Stripe account type. Can bestandard
,express
,custom
, ornone
. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object. -
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 interfaceMetadataStore<Account>
-