Stripe.Resources.FinancialConnections.Account (tiger_stripe v0.3.0)

Copy Markdown View Source

BankConnectionsResourceLinkedAccount

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

@type account_holder() :: %{
  optional(:account) => String.t() | Stripe.Resources.Account.t() | nil,
  optional(:customer) => String.t() | Stripe.Resources.Customer.t() | nil,
  optional(:customer_account) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • account - The ID of the Stripe account that this account belongs to. Only available when account_holder.type is account.
  • customer - The ID for an Account representing a customer that this account belongs to. Only available when account_holder.type is customer.
  • customer_account - Max length: 5000.
  • type - Type of account holder that this account belongs to. Possible values: account, customer.

account_numbers()

@type account_numbers() :: %{
  optional(:expected_expiry_date) => integer() | nil,
  optional(:identifier_type) => String.t() | nil,
  optional(:status) => String.t() | nil,
  optional(:supported_networks) => [String.t()] | nil,
  optional(String.t()) => term()
}
  • expected_expiry_date - When the account number is expected to expire, if applicable. Format: Unix timestamp. Nullable.
  • identifier_type - The type of account number associated with the account. Possible values: account_number, tokenized_account_number.
  • status - Whether the account number is currently active and usable for transactions. Possible values: deactivated, transactable.
  • supported_networks - The payment networks that the account number can be used for.

balance()

@type balance() :: %{
  optional(:as_of) => integer() | nil,
  optional(:cash) => balance_cash() | nil,
  optional(:credit) => balance_credit() | nil,
  optional(:current) => %{required(String.t()) => integer()} | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • as_of - The time that the external institution calculated this balance. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • cash
  • credit
  • current - The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.

Each key is a three-letter ISO currency code, in lowercase.

Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.

  • type - The type of the balance. An additional hash is included on the balance with a name matching this value. Possible values: cash, credit.

balance_cash()

@type balance_cash() :: %{
  optional(:available) => %{required(String.t()) => integer()} | nil,
  optional(String.t()) => term()
}
  • available - The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.

Each key is a three-letter ISO currency code, in lowercase.

Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. Nullable.

balance_credit()

@type balance_credit() :: %{
  optional(:used) => %{required(String.t()) => integer()} | nil,
  optional(String.t()) => term()
}
  • used - The credit that has been used by the account holder.

Each key is a three-letter ISO currency code, in lowercase.

Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. Nullable.

balance_refresh()

@type balance_refresh() :: %{
  optional(:last_attempted_at) => integer() | nil,
  optional(:next_refresh_available_at) => integer() | nil,
  optional(:status) => String.t() | nil,
  optional(String.t()) => term()
}
  • last_attempted_at - The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • next_refresh_available_at - Time at which the next balance refresh can be initiated. This value will be null when status is pending. Measured in seconds since the Unix epoch. Format: Unix timestamp. Nullable.
  • status - The status of the last refresh attempt. Possible values: failed, pending, succeeded.

ownership_refresh()

@type ownership_refresh() :: %{
  optional(:last_attempted_at) => integer() | nil,
  optional(:next_refresh_available_at) => integer() | nil,
  optional(:status) => String.t() | nil,
  optional(String.t()) => term()
}
  • last_attempted_at - The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • next_refresh_available_at - Time at which the next ownership refresh can be initiated. This value will be null when status is pending. Measured in seconds since the Unix epoch. Format: Unix timestamp. Nullable.
  • status - The status of the last refresh attempt. Possible values: failed, pending, succeeded.

t()

@type t() :: %Stripe.Resources.FinancialConnections.Account{
  account_holder: account_holder(),
  account_numbers: [account_numbers()],
  balance: balance(),
  balance_refresh: balance_refresh(),
  category: String.t(),
  created: integer(),
  display_name: String.t(),
  id: String.t(),
  institution_name: String.t(),
  last4: String.t(),
  livemode: boolean(),
  object: String.t(),
  ownership:
    String.t() | Stripe.Resources.FinancialConnections.AccountOwnership.t(),
  ownership_refresh: ownership_refresh(),
  permissions: [String.t()],
  status: String.t(),
  subcategory: String.t(),
  subscriptions: [String.t()],
  supported_payment_method_types: [String.t()],
  transaction_refresh: transaction_refresh()
}
  • account_holder - The account holder that this account belongs to. Nullable. Expandable.
  • account_numbers - Details about the account numbers. Nullable. Expandable.
  • balance - The most recent information about the account's balance. Nullable. Expandable.
  • balance_refresh - The state of the most recent attempt to refresh the account balance. Nullable. Expandable.
  • category - The type of the account. Account category is further divided in subcategory. Possible values: cash, credit, investment, other.
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • display_name - A human-readable name that has been assigned to this account, either by the account holder or by the institution. Max length: 5000. Nullable.
  • id - Unique identifier for the object. Max length: 5000.
  • institution_name - The name of the institution that holds this account. Max length: 5000.
  • last4 - The last 4 digits of the account number. If present, this will be 4 numeric characters. Max length: 5000. Nullable.
  • 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. Possible values: financial_connections.account.
  • ownership - The most recent information about the account's owners. Nullable. Expandable.
  • ownership_refresh - The state of the most recent attempt to refresh the account owners. Nullable. Expandable.
  • permissions - The list of permissions granted by this account. Nullable.
  • status - The status of the link to the account. Possible values: active, disconnected, inactive.
  • 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. Possible values: checking, credit_card, line_of_credit, mortgage, other, savings.

  • subscriptions - The list of data refresh subscriptions requested on this account. Nullable.
  • 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. Nullable. Expandable.

transaction_refresh()

@type transaction_refresh() :: %{
  optional(:id) => String.t() | nil,
  optional(:last_attempted_at) => integer() | nil,
  optional(:next_refresh_available_at) => integer() | nil,
  optional(:status) => String.t() | nil,
  optional(String.t()) => term()
}
  • id - Unique identifier for the object. Max length: 5000.
  • last_attempted_at - The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • next_refresh_available_at - Time at which the next transaction refresh can be initiated. This value will be null when status is pending. Measured in seconds since the Unix epoch. Format: Unix timestamp. Nullable.
  • status - The status of the last refresh attempt. Possible values: failed, pending, succeeded.

Functions

expandable_fields()

object_name()