public class Account extends ApiResource implements MetadataStore<Account>, PaymentSource
| Modifier and Type | Class and Description |
|---|---|
static class |
Account.BusinessProfile |
static class |
Account.Capabilities |
static class |
Account.Company |
static class |
Account.DeclineChargeOn
Get expanded
front. |
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 |
ApiResource.RequestMethodCHARSET, GSONPRETTY_PRINT_GSON| Constructor and Description |
|---|
Account() |
| Modifier and Type | Method and 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(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.
|
Account |
delete(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(AccountRetrieveParams 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.
|
static Account |
retrieve(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,
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.lang.String account,
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.
|
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeIdequals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetLastResponse, setLastResponsepublic static Account retrieve() throws StripeException
StripeExceptionpublic static Account retrieve(RequestOptions options) throws StripeException
StripeExceptionpublic static Account retrieve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeExceptionpublic static Account retrieve(AccountRetrieveParams params, RequestOptions options) throws StripeException
StripeExceptionpublic static Account retrieve(java.lang.String account) throws StripeException
StripeExceptionpublic static Account retrieve(java.lang.String account, RequestOptions options) throws StripeException
StripeExceptionpublic static Account retrieve(java.lang.String account, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeExceptionpublic static Account retrieve(java.lang.String account, AccountRetrieveParams params, RequestOptions options) throws StripeException
StripeExceptionpublic Account update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
update in interface MetadataStore<Account>StripeExceptionpublic Account update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
update in interface MetadataStore<Account>StripeExceptionpublic Account update(AccountUpdateParams params) throws StripeException
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
StripeExceptionpublic Account update(AccountUpdateParams params, RequestOptions options) throws StripeException
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
StripeExceptionpublic static AccountCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeExceptionpublic static AccountCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeExceptionpublic static AccountCollection list(AccountListParams params) throws StripeException
StripeExceptionpublic static AccountCollection list(AccountListParams params, RequestOptions options) throws StripeException
StripeExceptionpublic static Account create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeExceptionpublic static Account create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeExceptionpublic static Account create(AccountCreateParams params) throws StripeException
StripeExceptionpublic static Account create(AccountCreateParams params, RequestOptions options) throws StripeException
StripeExceptionpublic Account delete() throws StripeException
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.
StripeExceptionpublic Account delete(RequestOptions options) throws StripeException
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.
StripeExceptionpublic Account delete(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
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.
StripeExceptionpublic Account delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
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.
StripeExceptionpublic Account reject(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
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.
StripeExceptionpublic Account reject(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
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.
StripeExceptionpublic Account reject(AccountRejectParams params) throws StripeException
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.
StripeExceptionpublic Account reject(AccountRejectParams params, RequestOptions options) throws StripeException
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.
StripeExceptionpublic PersonCollection persons() throws StripeException
StripeExceptionpublic PersonCollection persons(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeExceptionpublic PersonCollection persons(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeExceptionpublic PersonCollection persons(AccountPersonsParams params) throws StripeException
StripeExceptionpublic PersonCollection persons(AccountPersonsParams params, RequestOptions options) throws StripeException
StripeExceptionpublic CapabilityCollection capabilities() throws StripeException
StripeExceptionpublic CapabilityCollection capabilities(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeExceptionpublic CapabilityCollection capabilities(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeExceptionpublic CapabilityCollection capabilities(AccountCapabilitiesParams params) throws StripeException
StripeExceptionpublic CapabilityCollection capabilities(AccountCapabilitiesParams params, RequestOptions options) throws StripeException
StripeExceptionpublic Account.BusinessProfile getBusinessProfile()
public java.lang.String getBusinessType()
One of company, government_entity, individual, or non_profit.
public Account.Capabilities getCapabilities()
public java.lang.Boolean getChargesEnabled()
public Account.Company getCompany()
public java.lang.String getCountry()
public java.lang.Long getCreated()
public java.lang.String getDefaultCurrency()
public java.lang.Boolean getDeleted()
public java.lang.Boolean getDetailsSubmitted()
public java.lang.String getEmail()
public ExternalAccountCollection getExternalAccounts()
public Person getIndividual()
Related guide: Handling Identity Verification with the API.
public java.lang.String getObject()
Equal to account.
public java.lang.Boolean getPayoutsEnabled()
public Account.Requirements getRequirements()
public Account.Settings getSettings()
public Account.TosAcceptance getTosAcceptance()
public java.lang.String getType()
standard, express, or custom.public void setBusinessProfile(Account.BusinessProfile businessProfile)
public void setBusinessType(java.lang.String businessType)
One of company, government_entity, individual, or non_profit.
public void setCapabilities(Account.Capabilities capabilities)
public void setChargesEnabled(java.lang.Boolean chargesEnabled)
public void setCompany(Account.Company company)
public void setCountry(java.lang.String country)
public void setCreated(java.lang.Long created)
public void setDefaultCurrency(java.lang.String defaultCurrency)
public void setDeleted(java.lang.Boolean deleted)
public void setDetailsSubmitted(java.lang.Boolean detailsSubmitted)
public void setEmail(java.lang.String email)
public void setExternalAccounts(ExternalAccountCollection externalAccounts)
public void setId(java.lang.String id)
public void setIndividual(Person individual)
Related guide: Handling Identity Verification with the API.
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
public void setObject(java.lang.String object)
Equal to account.
public void setPayoutsEnabled(java.lang.Boolean payoutsEnabled)
public void setRequirements(Account.Requirements requirements)
public void setSettings(Account.Settings settings)
public void setTosAcceptance(Account.TosAcceptance tosAcceptance)
public void setType(java.lang.String type)
standard, express, or custom.public boolean equals(java.lang.Object o)
equals in class java.lang.Objectprotected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode in class java.lang.Objectpublic java.lang.String getId()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
getMetadata in interface MetadataStore<Account>