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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAccount.BusinessProfilestatic classAccount.Capabilitiesstatic classAccount.Companystatic classAccount.ControllerGet expandedfront.static classAccount.DeclineChargeOnstatic classAccount.PayoutSchedulestatic classAccount.Requirementsstatic classAccount.SettingsThe specific user onboarding requirement field (in the requirements hash) that needs to be resolved.static classAccount.SettingsBrandingThe user agent of the browser from which the account representative accepted the service agreement.static classAccount.SettingsCardPaymentsstatic classAccount.SettingsDashboardstatic classAccount.SettingsPaymentsstatic classAccount.SettingsPayoutsstatic classAccount.TosAcceptance-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(java.lang.Object other)CapabilityCollectioncapabilities()Returns a list of capabilities associated with the account.CapabilityCollectioncapabilities(AccountCapabilitiesParams params)Returns a list of capabilities associated with the account.CapabilityCollectioncapabilities(AccountCapabilitiesParams params, RequestOptions options)Returns a list of capabilities associated with the account.CapabilityCollectioncapabilities(java.util.Map<java.lang.String,java.lang.Object> params)Returns a list of capabilities associated with the account.CapabilityCollectioncapabilities(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Returns a list of capabilities associated with the account.static Accountcreate(AccountCreateParams params)With Connect, you can create Stripe accounts for your users.static Accountcreate(AccountCreateParams params, RequestOptions options)With Connect, you can create Stripe accounts for your users.static Accountcreate(java.util.Map<java.lang.String,java.lang.Object> params)With Connect, you can create Stripe accounts for your users.static Accountcreate(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)With Connect, you can create Stripe accounts for your users.Accountdelete()With Connect, you can delete accounts you manage.Accountdelete(RequestOptions options)With Connect, you can delete accounts you manage.Accountdelete(java.util.Map<java.lang.String,java.lang.Object> params)With Connect, you can delete accounts you manage.Accountdelete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)With Connect, you can delete accounts you manage.booleanequals(java.lang.Object o)Account.BusinessProfilegetBusinessProfile()Business information about the account.java.lang.StringgetBusinessType()The business type.Account.CapabilitiesgetCapabilities()java.lang.BooleangetChargesEnabled()Whether the account can create live charges.Account.CompanygetCompany()Account.ControllergetController()java.lang.StringgetCountry()The account's country.java.lang.LonggetCreated()Time at which the object was created.java.lang.StringgetDefaultCurrency()Three-letter ISO currency code representing the default currency for the account.java.lang.BooleangetDeleted()Always true for a deleted object.java.lang.BooleangetDetailsSubmitted()Whether account details have been submitted.java.lang.StringgetEmail()An email address associated with the account.ExternalAccountCollectiongetExternalAccounts()External accounts (bank accounts and debit cards) currently attached to this account.java.lang.StringgetId()Unique identifier for the object.PersongetIndividual()This is an object representing a person associated with a Stripe account.java.util.Map<java.lang.String,java.lang.String>getMetadata()Set of key-value pairs that you can attach to an object.java.lang.StringgetObject()String representing the object's type.java.lang.BooleangetPayoutsEnabled()Whether Stripe can send payouts to this account.Account.RequirementsgetRequirements()Account.SettingsgetSettings()Options for customizing how the account functions within Stripe.Account.TosAcceptancegetTosAcceptance()java.lang.StringgetType()The Stripe account type.inthashCode()static AccountCollectionlist(AccountListParams params)Returns a list of accounts connected to your platform via Connect.static AccountCollectionlist(AccountListParams params, RequestOptions options)Returns a list of accounts connected to your platform via Connect.static AccountCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params)Returns a list of accounts connected to your platform via Connect.static AccountCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Returns a list of accounts connected to your platform via Connect.PersonCollectionpersons()Returns a list of people associated with the account’s legal entity.PersonCollectionpersons(AccountPersonsParams params)Returns a list of people associated with the account’s legal entity.PersonCollectionpersons(AccountPersonsParams params, RequestOptions options)Returns a list of people associated with the account’s legal entity.PersonCollectionpersons(java.util.Map<java.lang.String,java.lang.Object> params)Returns a list of people associated with the account’s legal entity.PersonCollectionpersons(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Returns a list of people associated with the account’s legal entity.Accountreject(AccountRejectParams params)With Connect, you may flag accounts as suspicious.Accountreject(AccountRejectParams params, RequestOptions options)With Connect, you may flag accounts as suspicious.Accountreject(java.util.Map<java.lang.String,java.lang.Object> params)With Connect, you may flag accounts as suspicious.Accountreject(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)With Connect, you may flag accounts as suspicious.static Accountretrieve()Retrieves the details of an account.static Accountretrieve(RequestOptions options)Retrieves the details of an account.static Accountretrieve(AccountRetrieveParams params, RequestOptions options)Retrieves the details of an account.static Accountretrieve(java.lang.String account)Retrieves the details of an account.static Accountretrieve(java.lang.String account, RequestOptions options)Retrieves the details of an account.static Accountretrieve(java.lang.String account, AccountRetrieveParams params, RequestOptions options)Retrieves the details of an account.static Accountretrieve(java.lang.String account, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Retrieves the details of an account.static Accountretrieve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Retrieves the details of an account.voidsetBusinessProfile(Account.BusinessProfile businessProfile)Business information about the account.voidsetBusinessType(java.lang.String businessType)The business type.voidsetCapabilities(Account.Capabilities capabilities)voidsetChargesEnabled(java.lang.Boolean chargesEnabled)Whether the account can create live charges.voidsetCompany(Account.Company company)voidsetController(Account.Controller controller)voidsetCountry(java.lang.String country)The account's country.voidsetCreated(java.lang.Long created)Time at which the object was created.voidsetDefaultCurrency(java.lang.String defaultCurrency)Three-letter ISO currency code representing the default currency for the account.voidsetDeleted(java.lang.Boolean deleted)Always true for a deleted object.voidsetDetailsSubmitted(java.lang.Boolean detailsSubmitted)Whether account details have been submitted.voidsetEmail(java.lang.String email)An email address associated with the account.voidsetExternalAccounts(ExternalAccountCollection externalAccounts)External accounts (bank accounts and debit cards) currently attached to this account.voidsetId(java.lang.String id)Unique identifier for the object.voidsetIndividual(Person individual)This is an object representing a person associated with a Stripe account.voidsetMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)Set of key-value pairs that you can attach to an object.voidsetObject(java.lang.String object)String representing the object's type.voidsetPayoutsEnabled(java.lang.Boolean payoutsEnabled)Whether Stripe can send payouts to this account.voidsetRequirements(Account.Requirements requirements)voidsetSettings(Account.Settings settings)Options for customizing how the account functions within Stripe.voidsetTosAcceptance(Account.TosAcceptance tosAcceptance)voidsetType(java.lang.String type)The Stripe account type.Accountupdate(AccountUpdateParams params)Updates a connected account by setting the values of the parameters passed.Accountupdate(AccountUpdateParams params, RequestOptions options)Updates a connected account by setting the values of the parameters passed.Accountupdate(java.util.Map<java.lang.String,java.lang.Object> params)Updates a connected account by setting the values of the parameters passed.Accountupdate(java.util.Map<java.lang.String,java.lang.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, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, 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
-
-
-
-
Method Detail
-
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(java.util.Map<java.lang.String,java.lang.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(java.lang.String account) throws StripeException
Retrieves the details of an account.- Throws:
StripeException
-
retrieve
public static Account retrieve(java.lang.String account, RequestOptions options) throws StripeException
Retrieves the details of an account.- Throws:
StripeException
-
retrieve
public static Account retrieve(java.lang.String account, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the details of an account.- Throws:
StripeException
-
retrieve
public static Account retrieve(java.lang.String account, AccountRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the details of an account.- Throws:
StripeException
-
update
public Account update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
- Specified by:
updatein interfaceMetadataStore<Account>- Throws:
StripeException
-
update
public Account update(java.util.Map<java.lang.String,java.lang.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. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
- Specified by:
updatein interfaceMetadataStore<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. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.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. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
- Throws:
StripeException
-
list
public static AccountCollection list(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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
-
create
public static Account create(java.util.Map<java.lang.String,java.lang.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.- Throws:
StripeException
-
create
public static Account create(java.util.Map<java.lang.String,java.lang.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.- 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.- 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.- 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. 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. 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(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
With Connect, you can delete accounts you manage.Accounts created using test-mode keys can be deleted at any time. 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(java.util.Map<java.lang.String,java.lang.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. 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
-
reject
public Account reject(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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
-
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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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
-
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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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
-
getBusinessProfile
public Account.BusinessProfile getBusinessProfile()
Business information about the account.
-
getBusinessType
public java.lang.String getBusinessType()
The business type.One of
company,government_entity,individual, ornon_profit.
-
getCapabilities
public Account.Capabilities getCapabilities()
-
getChargesEnabled
public java.lang.Boolean getChargesEnabled()
Whether the account can create live charges.
-
getCompany
public Account.Company getCompany()
-
getController
public Account.Controller getController()
-
getCountry
public java.lang.String getCountry()
The account's country.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getDefaultCurrency
public java.lang.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 java.lang.Boolean getDeleted()
Always true for a deleted object.
-
getDetailsSubmitted
public java.lang.Boolean getDetailsSubmitted()
Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
-
getEmail
public java.lang.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.
-
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 java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
account.
-
getPayoutsEnabled
public java.lang.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 java.lang.String getType()
The Stripe account type. Can bestandard,express, orcustom.
-
setBusinessProfile
public void setBusinessProfile(Account.BusinessProfile businessProfile)
Business information about the account.
-
setBusinessType
public void setBusinessType(java.lang.String businessType)
The business type.One of
company,government_entity,individual, ornon_profit.
-
setCapabilities
public void setCapabilities(Account.Capabilities capabilities)
-
setChargesEnabled
public void setChargesEnabled(java.lang.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(java.lang.String country)
The account's country.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setDefaultCurrency
public void setDefaultCurrency(java.lang.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(java.lang.Boolean deleted)
Always true for a deleted object.
-
setDetailsSubmitted
public void setDetailsSubmitted(java.lang.Boolean detailsSubmitted)
Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
-
setEmail
public void setEmail(java.lang.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.
-
setId
public void setId(java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
account.
-
setPayoutsEnabled
public void setPayoutsEnabled(java.lang.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(java.lang.String type)
The Stripe account type. Can bestandard,express, orcustom.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.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:
getMetadatain interfaceMetadataStore<Account>
-
-