Package com.stripe.service

Class AccountService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.AccountService

public final class AccountService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
AccountService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
AccountCapabilityService	capabilities()
Account	create()	With Connect, you can create Stripe accounts for your users.
Account	create(RequestOptions options)	With Connect, you can create Stripe accounts for your users.
Account	create(AccountCreateParams params)	With Connect, you can create Stripe accounts for your users.
Account	create(AccountCreateParams params, RequestOptions options)	With Connect, you can create Stripe accounts for your users.
Account	delete(String account)	With Connect, you can delete accounts you manage.
Account	delete(String account, RequestOptions options)	With Connect, you can delete accounts you manage.
AccountExternalAccountService	externalAccounts()
StripeCollection<Account>	list()	Returns a list of accounts connected to your platform via Connect.
StripeCollection<Account>	list(RequestOptions options)	Returns a list of accounts connected to your platform via Connect.
StripeCollection<Account>	list(AccountListParams params)	Returns a list of accounts connected to your platform via Connect.
StripeCollection<Account>	list(AccountListParams params, RequestOptions options)	Returns a list of accounts connected to your platform via Connect.
AccountLoginLinkService	loginLinks()
AccountPersonService	persons()
Account	reject(String account, AccountRejectParams params)	With Connect, you can reject accounts that you have flagged as suspicious.
Account	reject(String account, AccountRejectParams params, RequestOptions options)	With Connect, you can reject accounts that you have flagged as suspicious.
Account	retrieve(String account)	Retrieves the details of an account.
Account	retrieve(String account, RequestOptions options)	Retrieves the details of an account.
Account	retrieve(String account, AccountRetrieveParams params)	Retrieves the details of an account.
Account	retrieve(String account, AccountRetrieveParams params, RequestOptions options)	Retrieves the details of an account.
Account	retrieveCurrent()	Retrieves the details of an account.
Account	retrieveCurrent(RequestOptions options)	Retrieves the details of an account.
Account	retrieveCurrent(AccountRetrieveCurrentParams params)	Retrieves the details of an account.
Account	retrieveCurrent(AccountRetrieveCurrentParams params, RequestOptions options)	Retrieves the details of an account.
Account	update(String account)	Updates a connected account by setting the values of the parameters passed.
Account	update(String account, RequestOptions options)	Updates a connected account by setting the values of the parameters passed.
Account	update(String account, AccountUpdateParams params)	Updates a connected account by setting the values of the parameters passed.
Account	update(String account, AccountUpdateParams params, RequestOptions options)	Updates a connected account by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AccountService

public AccountService(StripeResponseGetter responseGetter)

Method Details

delete

public Account delete(String account)
               throws StripeException

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

public Account delete(String account,
 RequestOptions options)
               throws StripeException

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

retrieve

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

Retrieves the details of an account.

Throws:

StripeException

retrieve

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

Retrieves the details of an account.

Throws:

StripeException

retrieve

public Account retrieve(String account)
                 throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieve

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

Retrieves the details of an account.

Throws:

StripeException

update

public Account update(String account,
 AccountUpdateParams params)
               throws StripeException

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

public Account update(String account,
 RequestOptions options)
               throws StripeException

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

public Account update(String account)
               throws StripeException

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

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

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

For 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

retrieveCurrent

public Account retrieveCurrent(AccountRetrieveCurrentParams params)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieveCurrent

public Account retrieveCurrent(RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieveCurrent

public Account retrieveCurrent()
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

retrieveCurrent

public Account retrieveCurrent(AccountRetrieveCurrentParams params,
 RequestOptions options)
                        throws StripeException

Retrieves the details of an account.

Throws:

StripeException

list

public StripeCollection<Account> 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 StripeCollection<Account> list(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 StripeCollection<Account> list()
                               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 StripeCollection<Account> 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 Account create(AccountCreateParams params)
               throws StripeException

With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.

If you’ve already collected information for your connected accounts, you can 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 Account create(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

create

public Account create()
               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

create

public 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

reject

public Account reject(String account,
 AccountRejectParams params)
               throws StripeException

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

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

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

capabilities

public AccountCapabilityService capabilities()

externalAccounts

public AccountExternalAccountService externalAccounts()

loginLinks

public AccountLoginLinkService loginLinks()

persons

public AccountPersonService persons()