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 class
Account.BusinessProfile
static class
Account.Capabilities
static class
Account.Company
static class
Account.DeclineChargeOn
Get expandedfront
.static class
Account.PayoutSchedule
static class
Account.Requirements
static class
Account.Settings
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.static class
Account.SettingsBranding
SEPA creditor identifier that identifies the company making the payment.static class
Account.SettingsCardPayments
static class
Account.SettingsDashboard
static class
Account.SettingsPayments
static class
Account.SettingsPayouts
static class
Account.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 boolean
canEqual(java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of capabilities associated with the account.CapabilityCollection
capabilities(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
With Connect, you can create Stripe accounts for your users.static Account
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
With Connect, you can create Stripe accounts for your users.Account
delete()
With Connect, you can delete Custom or Express accounts you manage.Account
delete(RequestOptions options)
With Connect, you can delete Custom or Express accounts you manage.Account
delete(java.util.Map<java.lang.String,java.lang.Object> params)
With Connect, you can delete Custom or Express accounts you manage.Account
delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
With Connect, you can delete Custom or Express accounts you manage.boolean
equals(java.lang.Object o)
Account.BusinessProfile
getBusinessProfile()
Business information about the account.java.lang.String
getBusinessType()
The business type.Account.Capabilities
getCapabilities()
java.lang.Boolean
getChargesEnabled()
Whether the account can create live charges.Account.Company
getCompany()
java.lang.String
getCountry()
The account's country.java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getDefaultCurrency()
Three-letter ISO currency code representing the default currency for the account.java.lang.Boolean
getDeleted()
Always true for a deleted object.java.lang.Boolean
getDetailsSubmitted()
Whether account details have been submitted.java.lang.String
getEmail()
The primary user's email address.ExternalAccountCollection
getExternalAccounts()
External accounts (bank accounts and debit cards) currently attached to this account.java.lang.String
getId()
Unique identifier for the object.Person
getIndividual()
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.String
getObject()
String representing the object's type.java.lang.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()
java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of accounts connected to your platform via Connect.static AccountCollection
list(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of people associated with the account’s legal entity.PersonCollection
persons(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> params)
With Connect, you may flag accounts as suspicious.Account
reject(java.util.Map<java.lang.String,java.lang.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(java.lang.String account)
Retrieves the details of an account.static Account
retrieve(java.lang.String account, RequestOptions options)
Retrieves the details of an account.static Account
retrieve(java.lang.String account, AccountRetrieveParams params, RequestOptions options)
Retrieves the details of an account.static Account
retrieve(java.lang.String account, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the details of an account.static Account
retrieve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the details of an account.void
setBusinessProfile(Account.BusinessProfile businessProfile)
Business information about the account.void
setBusinessType(java.lang.String businessType)
The business type.void
setCapabilities(Account.Capabilities capabilities)
void
setChargesEnabled(java.lang.Boolean chargesEnabled)
Whether the account can create live charges.void
setCompany(Account.Company company)
void
setCountry(java.lang.String country)
The account's country.void
setCreated(java.lang.Long created)
Time at which the object was created.void
setDefaultCurrency(java.lang.String defaultCurrency)
Three-letter ISO currency code representing the default currency for the account.void
setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.void
setDetailsSubmitted(java.lang.Boolean detailsSubmitted)
Whether account details have been submitted.void
setEmail(java.lang.String email)
The primary user's email address.void
setExternalAccounts(ExternalAccountCollection externalAccounts)
External accounts (bank accounts and debit cards) currently attached to this account.void
setId(java.lang.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(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.void
setObject(java.lang.String object)
String representing the object's type.void
setPayoutsEnabled(java.lang.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(java.lang.String type)
The Stripe account type.Account
update(AccountUpdateParams params)
Updates a connected Express or Custom account by setting the values of the parameters passed.Account
update(AccountUpdateParams params, RequestOptions options)
Updates a connected Express or Custom account by setting the values of the parameters passed.Account
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates a connected Express or Custom account by setting the values of the parameters passed.Account
update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Updates a connected Express or Custom 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 Express or Custom 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 supported by both account types.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
public Account update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates a connected Express or Custom 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 supported by both account types.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
public Account update(AccountUpdateParams params) throws StripeException
Updates a connected Express or Custom 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 supported by both account types.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 Express or Custom 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 supported by both account types.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 Custom or Express accounts you manage.Accounts created using test-mode keys can be deleted at any time. 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 Custom or Express accounts you manage.Accounts created using test-mode keys can be deleted at any time. 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 Custom or Express accounts you manage.Accounts created using test-mode keys can be deleted at any time. 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 Custom or Express accounts you manage.Accounts created using test-mode keys can be deleted at any time. 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()
-
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()
The primary user's email address.
-
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.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)
-
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)
The primary user's email address.
-
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.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:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in 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:
getMetadata
in interfaceMetadataStore<Account>
-
-