Class Account

    • Constructor Detail

      • Account

        public Account()
    • Method Detail

      • 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:
        update in interface MetadataStore<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:
        update in interface MetadataStore<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
      • 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
      • 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
      • 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
      • 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
      • getBusinessType

        public java.lang.String getBusinessType()
        The business type.

        One of company, government_entity, individual, or non_profit.

      • getChargesEnabled

        public java.lang.Boolean getChargesEnabled()
        Whether the account can create live charges.
      • 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.
      • 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.
      • getSettings

        public Account.Settings getSettings()
        Options for customizing how the account functions within Stripe.
      • getType

        public java.lang.String getType()
        The Stripe account type. Can be standard, express, or custom.
      • 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, or non_profit.

      • setChargesEnabled

        public void setChargesEnabled​(java.lang.Boolean chargesEnabled)
        Whether the account can create live charges.
      • 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.
      • 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.
      • setSettings

        public void setSettings​(Account.Settings settings)
        Options for customizing how the account functions within Stripe.
      • setType

        public void setType​(java.lang.String type)
        The Stripe account type. Can be standard, express, or custom.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId
      • 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 interface MetadataStore<Account>