View Source Stripe.FinancialConnections.Account (stripity_stripe v3.2.0)

A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.

Summary

Types

account_holder()

t()

The financial_connections.account type.

Functions

disconnect(account, params \\ %{}, opts \\ [])

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).

list(params \\ %{}, opts \\ [])

Returns a list of Financial Connections Account objects.

list_owners(account, params \\ %{}, opts \\ [])

Lists all owners for a given Account

refresh(account, params \\ %{}, opts \\ [])

Refreshes the data associated with a Financial Connections Account.

retrieve(account, params \\ %{}, opts \\ [])

Retrieves the details of an Financial Connections Account.

subscribe(account, params \\ %{}, opts \\ [])

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

unsubscribe(account, params \\ %{}, opts \\ [])

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

Types

account_holder()

@type account_holder() :: %{
  optional(:account) => binary(),
  optional(:customer) => binary()
}

t()

@type t() :: %Stripe.FinancialConnections.Account{
  account_holder: term() | nil,
  balance: term() | nil,
  balance_refresh: term() | nil,
  category: binary(),
  created: integer(),
  display_name: binary() | nil,
  id: binary(),
  institution_name: binary(),
  last4: binary() | nil,
  livemode: boolean(),
  object: binary(),
  ownership: (binary() | term()) | nil,
  ownership_refresh: term() | nil,
  permissions: term() | nil,
  status: binary(),
  subcategory: binary(),
  subscriptions: term() | nil,
  supported_payment_method_types: term(),
  transaction_refresh: term() | nil
}

The financial_connections.account type.

account_holder The account holder that this account belongs to.
balance The most recent information about the account's balance.
balance_refresh The state of the most recent attempt to refresh the account balance.
category The type of the account. Account category is further divided in subcategory.
created Time at which the object was created. Measured in seconds since the Unix epoch.
display_name A human-readable name that has been assigned to this account, either by the account holder or by the institution.
id Unique identifier for the object.
institution_name The name of the institution that holds this account.
last4 The last 4 digits of the account number. If present, this will be 4 numeric characters.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
ownership The most recent information about the account's owners.
ownership_refresh The state of the most recent attempt to refresh the account owners.
permissions The list of permissions granted by this account.
status The status of the link to the account.
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.

subscriptions The list of data refresh subscriptions requested on this account.
supported_payment_method_types The PaymentMethod type(s) that can be created from this account.
transaction_refresh The state of the most recent attempt to refresh the account transactions.

Functions

disconnect(account, params \\ %{}, opts \\ [])

@spec disconnect(
  account :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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).

Details

Method: post
Path: /v1/financial_connections/accounts/{account}/disconnect

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:account_holder) => account_holder(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:session) => binary(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of Financial Connections Account objects.

Details

Method: get
Path: /v1/financial_connections/accounts

list_owners(account, params \\ %{}, opts \\ [])

@spec list_owners(
  account :: binary(),
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:ownership) => binary(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(Stripe.FinancialConnections.AccountOwner.t())}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Lists all owners for a given Account

Details

Method: get
Path: /v1/financial_connections/accounts/{account}/owners

refresh(account, params \\ %{}, opts \\ [])

@spec refresh(
  account :: binary(),
  params :: %{
    optional(:expand) => [binary()],
    optional(:features) => [:balance | :ownership | :transactions]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Refreshes the data associated with a Financial Connections Account.

Details

Method: post
Path: /v1/financial_connections/accounts/{account}/refresh

retrieve(account, params \\ %{}, opts \\ [])

@spec retrieve(
  account :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of an Financial Connections Account.

Details

Method: get
Path: /v1/financial_connections/accounts/{account}

unsubscribe(account, params \\ %{}, opts \\ [])

@spec unsubscribe(
  account :: binary(),
  params :: %{
    optional(:expand) => [binary()],
    optional(:features) => [:transactions]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

Details

Method: post
Path: /v1/financial_connections/accounts/{account}/unsubscribe