Skip to content

Latest commit

 

History

History
31 lines (26 loc) · 4.14 KB

File metadata and controls

31 lines (26 loc) · 4.14 KB

AccountCreateRequest

Properties

Name Type Description Notes
account_subtype Option<String> The account's subtype, for example, PLAN_401_K, MONEY_MARKET, or HOME_EQUITY. Each subtype belongs to an account type. For a full list of account subtypes and types, see Accounts. [optional]
account_type Option<AccountType> The type of account. Some account types may include subtypes. For a full list of account types and subtypes, see Account Types. (enum: ANY, CASH, CHECKING, CHECKING_LINE_OF_CREDIT, CREDIT_CARD, LOAN, LINE_OF_CREDIT, SAVINGS, INVESTMENT, MORTGAGE, INSURANCE, PREPAID, PROPERTY)
apr Option<f64> The annual percentage rate associated with the account. [optional]
apy Option<f64> The annual percentage yield associated with the account. [optional]
available_balance Option<f64> The balance that is available for use in asset accounts like checking and savings. PENDING transactions are typically (not always) taken into account with the available balance. available_balance will usually be a positive value for all account types, determined in the same way as the balance field. [optional]
balance Option<f64> The current balance of the account. PENDING transactions are typically not taken into account with the current balance, but this may not always be the case. The balance will usually be a positive value for all account types. Asset-type accounts (CHECKING, SAVINGS, INVESTMENT) may have a negative balance if they are in overdraft. Debt-type accounts (CREDIT_CARD, LOAN, LINE_OF_CREDIT, MORTGAGE) may have a negative balance if they are overpaid. [optional]
cash_surrender_value Option<f64> The sum of money paid to the policyholder or annuity holder in the event the policy is voluntarily terminated before it matures, or the insured event occurs. [optional]
credit_limit Option<f64> The credit limit associated with the account. [optional]
currency_code Option<String> The three-character ISO 4217 currency code, for example, USD. [optional]
death_benefit Option<i32> The amount paid to the beneficiary of the account upon death of the account owner. [optional]
interest_rate Option<f64> The interest rate associated with the account. [optional]
is_business Option<bool> Indicates whether the account is a business account. [optional]
is_closed Option<bool> Indicates whether an account has been closed. Closed accounts will no longer update balance or transaction information. [optional]
is_hidden Option<bool> Indicates whether the account is hidden. Hidden accounts can still have an active balance and receive transactions. Defaults to false. [optional]
loan_amount Option<f64> The amount of the loan associated with the account. [optional]
metadata Option<String> Additional information you can store about the account. [optional]
name String The human-readable name for the account.
nickname Option<String> An alternate name for the account. [optional]
original_balance Option<f64> The original balance associated with the account. This will always be positive. [optional]
property_type Option<PropertyType> Subtype if the account type is PROPERTY. This field should be ignored unless the type is set to PROPERTY. For a full list of property types, see Account Types. (enum: APPLIANCES, ART, COMPUTER, ELECTRONICS, FURNITURE, JEWELRY, MISCELLANEOUS, REAL_ESTATE, SPORTS_EQUIPMENT, VEHICLE) [optional]
skip_webhook Option<bool> If set to true, prevents sending an account webhook for the update if that webhook type is enabled for you. [optional]

[Back to Model list] [Back to API list] [Back to README]