![]() When returned by /accounts/balance/get, this field may be null. If you require realtime balance information, use the available balance as provided by /accounts/balance/get. Note that balance information may be cached unless the value was returned by /accounts/balance/get if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.įor investment-type accounts (or brokerage-type accounts for API versions and earlier), the current balance is the total value of assets as presented by the institution. ![]() The total amount of funds in or owed by the account.įor credit-type accounts, a positive balance indicates the amount owed a negative amount indicates the lender owing the account holder.įor loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae ( ins_116944). If current is null this field is guaranteed not to be null. In the event that available balance is unavailable, Plaid will return an available balance value of null.Īvailable balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get. ![]() Note that not all institutions calculate the available balance. For depository-type accounts, the available balance does not include the overdraft limit.įor investment-type accounts (or brokerage-type accounts for API versions and earlier), the available balance is the total cash available to withdraw as presented by the institution. The amount of funds available to be withdrawn from the account, as determined by the financial institution.įor credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.įor depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older.įor realtime balance information, use the paid endpoint /accounts/balance/get instead. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. The balance returned will reflect the balance at the time of the last successful Item update. accounts/get is free to use and retrieves cached information, rather than extracting fresh information from the institution. If a user creates a new account after the initial link, you can capture this event through the NEW_ACCOUNTS_AVAILABLE webhook and then use Link's update mode to request that the user share this new account with you. ![]() Plaid will only return active bank accounts - that is, accounts that are not closed and are capable of carrying a balance.įor items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. The /accounts/get endpoint can be used to retrieve a list of accounts associated with any linked Item. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |