Package com.stripe.model.financialconnections

Class Account

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.financialconnections.Account
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class Account extends ApiResource implements HasId
A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.

  • Constructor Details

    • Account

      public Account()

  • Method Details

    • getInstitution

      public String getInstitution()
      Get ID of expandable institution object.

    • setInstitution

      public void setInstitution(String id)

    • getInstitutionObject

      public Institution getInstitutionObject()
      Get expanded institution.

    • setInstitutionObject

      public void setInstitutionObject(Institution expandableObject)

    • getOwnership

      public String getOwnership()
      Get ID of expandable ownership object.

    • setOwnership

      public void setOwnership(String id)

    • getOwnershipObject

      public AccountOwnership getOwnershipObject()
      Get expanded ownership.

    • setOwnershipObject

      public void setOwnershipObject(AccountOwnership expandableObject)

    • disconnect

      public Account disconnect() throws StripeException
      Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
      Throws:
      StripeException

    • disconnect

      public Account disconnect(RequestOptions options) throws StripeException
      Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
      Throws:
      StripeException

    • disconnect

      public Account disconnect(Map<String,Object> params) throws StripeException
      Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
      Throws:
      StripeException

    • disconnect

      public Account disconnect(Map<String,Object> params, RequestOptions options) throws StripeException
      Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
      Throws:
      StripeException

    • disconnect

      public Account disconnect(AccountDisconnectParams params) throws StripeException
      Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
      Throws:
      StripeException

    • disconnect

      public Account disconnect(AccountDisconnectParams params, RequestOptions options) throws StripeException
      Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
      Throws:
      StripeException

    • list

      public static AccountCollection list(Map<String,Object> params) throws StripeException
      Returns a list of Financial Connections Account objects.
      Throws:
      StripeException

    • list

      public static AccountCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of Financial Connections Account objects.
      Throws:
      StripeException

    • list

      public static AccountCollection list(AccountListParams params) throws StripeException
      Returns a list of Financial Connections Account objects.
      Throws:
      StripeException

    • list

      public static AccountCollection list(AccountListParams params, RequestOptions options) throws StripeException
      Returns a list of Financial Connections Account objects.
      Throws:
      StripeException

    • listOwners

      public AccountOwnerCollection listOwners(Map<String,Object> params) throws StripeException
      Lists all owners for a given Account.
      Throws:
      StripeException

    • listOwners

      public AccountOwnerCollection listOwners(Map<String,Object> params, RequestOptions options) throws StripeException
      Lists all owners for a given Account.
      Throws:
      StripeException

    • listOwners

      public AccountOwnerCollection listOwners(AccountListOwnersParams params) throws StripeException
      Lists all owners for a given Account.
      Throws:
      StripeException

    • listOwners

      public AccountOwnerCollection listOwners(AccountListOwnersParams params, RequestOptions options) throws StripeException
      Lists all owners for a given Account.
      Throws:
      StripeException

    • refresh

      public Account refresh(Map<String,Object> params) throws StripeException
      Refreshes the data associated with a Financial Connections Account.
      Throws:
      StripeException

    • refresh

      public Account refresh(Map<String,Object> params, RequestOptions options) throws StripeException
      Refreshes the data associated with a Financial Connections Account.
      Throws:
      StripeException

    • refresh

      public Account refresh(AccountRefreshParams params) throws StripeException
      Refreshes the data associated with a Financial Connections Account.
      Throws:
      StripeException

    • refresh

      public Account refresh(AccountRefreshParams params, RequestOptions options) throws StripeException
      Refreshes the data associated with a Financial Connections Account.
      Throws:
      StripeException

    • retrieve

      public static Account retrieve(String account) throws StripeException
      Retrieves the details of an Financial Connections Account.
      Throws:
      StripeException

    • retrieve

      public static Account retrieve(String account, RequestOptions options) throws StripeException
      Retrieves the details of an Financial Connections Account.
      Throws:
      StripeException

    • retrieve

      public static Account retrieve(String account, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of an Financial Connections Account.
      Throws:
      StripeException

    • retrieve

      public static Account retrieve(String account, AccountRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of an Financial Connections Account.
      Throws:
      StripeException

    • subscribe

      public Account subscribe(Map<String,Object> params) throws StripeException
      Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.
      Throws:
      StripeException

    • subscribe

      public Account subscribe(Map<String,Object> params, RequestOptions options) throws StripeException
      Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.
      Throws:
      StripeException

    • subscribe

      public Account subscribe(AccountSubscribeParams params) throws StripeException
      Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.
      Throws:
      StripeException

    • subscribe

      public Account subscribe(AccountSubscribeParams params, RequestOptions options) throws StripeException
      Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.
      Throws:
      StripeException

    • unsubscribe

      public Account unsubscribe(Map<String,Object> params) throws StripeException
      Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
      Throws:
      StripeException

    • unsubscribe

      public Account unsubscribe(Map<String,Object> params, RequestOptions options) throws StripeException
      Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
      Throws:
      StripeException

    • unsubscribe

      public Account unsubscribe(AccountUnsubscribeParams params) throws StripeException
      Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
      Throws:
      StripeException

    • unsubscribe

      public Account unsubscribe(AccountUnsubscribeParams params, RequestOptions options) throws StripeException
      Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAccountHolder

      public Account.AccountHolder getAccountHolder()
      The account holder that this account belongs to.

    • getAccountNumbers

      public List<Account.AccountNumber> getAccountNumbers()
      Details about the account numbers.

    • getBalance

      public Account.Balance getBalance()
      The most recent information about the account's balance.

    • getBalanceRefresh

      public Account.BalanceRefresh getBalanceRefresh()
      The state of the most recent attempt to refresh the account balance.

    • getCategory

      public String getCategory()
      The type of the account. Account category is further divided in subcategory.

      One of cash, credit, investment, or other.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getDisplayName

      public String getDisplayName()
      A human-readable name that has been assigned to this account, either by the account holder or by the institution.

    • getInferredBalancesRefresh

      public Account.InferredBalancesRefresh getInferredBalancesRefresh()
      The state of the most recent attempt to refresh the account's inferred balance history.

    • getInstitutionName

      public String getInstitutionName()
      The name of the institution that holds this account.

    • getLast4

      public String getLast4()
      The last 4 digits of the account number. If present, this will be 4 numeric characters.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to financial_connections.account.

    • getOwnershipRefresh

      public Account.OwnershipRefresh getOwnershipRefresh()
      The state of the most recent attempt to refresh the account owners.

    • getPermissions

      public List<String> getPermissions()
      The list of permissions granted by this account.

    • getStatus

      public String getStatus()
      The status of the link to the account.

      One of active, disconnected, or inactive.

    • getSubcategory

      public String getSubcategory()
      If category is cash, one of:

      - checking - savings - other

      If category is credit, one of:

      - mortgage - line_of_credit - credit_card - other

      If category is investment or other, this will be other.

    • getSubscriptions

      public List<String> getSubscriptions()
      The list of data refresh subscriptions requested on this account.

    • getSupportedPaymentMethodTypes

      public List<String> getSupportedPaymentMethodTypes()
      The PaymentMethod type(s) that can be created from this account.

    • getTransactionRefresh

      public Account.TransactionRefresh getTransactionRefresh()
      The state of the most recent attempt to refresh the account transactions.

    • setAccountHolder

      public void setAccountHolder(Account.AccountHolder accountHolder)
      The account holder that this account belongs to.

    • setAccountNumbers

      public void setAccountNumbers(List<Account.AccountNumber> accountNumbers)
      Details about the account numbers.

    • setBalance

      public void setBalance(Account.Balance balance)
      The most recent information about the account's balance.

    • setBalanceRefresh

      public void setBalanceRefresh(Account.BalanceRefresh balanceRefresh)
      The state of the most recent attempt to refresh the account balance.

    • setCategory

      public void setCategory(String category)
      The type of the account. Account category is further divided in subcategory.

      One of cash, credit, investment, or other.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setDisplayName

      public void setDisplayName(String displayName)
      A human-readable name that has been assigned to this account, either by the account holder or by the institution.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setInferredBalancesRefresh

      public void setInferredBalancesRefresh(Account.InferredBalancesRefresh inferredBalancesRefresh)
      The state of the most recent attempt to refresh the account's inferred balance history.

    • setInstitutionName

      public void setInstitutionName(String institutionName)
      The name of the institution that holds this account.

    • setLast4

      public void setLast4(String last4)
      The last 4 digits of the account number. If present, this will be 4 numeric characters.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to financial_connections.account.

    • setOwnershipRefresh

      public void setOwnershipRefresh(Account.OwnershipRefresh ownershipRefresh)
      The state of the most recent attempt to refresh the account owners.

    • setPermissions

      public void setPermissions(List<String> permissions)
      The list of permissions granted by this account.

    • setStatus

      public void setStatus(String status)
      The status of the link to the account.

      One of active, disconnected, or inactive.

    • setSubcategory

      public void setSubcategory(String subcategory)
      If category is cash, one of:

      - checking - savings - other

      If category is credit, one of:

      - mortgage - line_of_credit - credit_card - other

      If category is investment or other, this will be other.

    • setSubscriptions

      public void setSubscriptions(List<String> subscriptions)
      The list of data refresh subscriptions requested on this account.

    • setSupportedPaymentMethodTypes

      public void setSupportedPaymentMethodTypes(List<String> supportedPaymentMethodTypes)
      The PaymentMethod type(s) that can be created from this account.

    • setTransactionRefresh

      public void setTransactionRefresh(Account.TransactionRefresh transactionRefresh)
      The state of the most recent attempt to refresh the account transactions.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId