Account types

What account types do we provide.

Overview

There are three account types:

  • Deposit accounts
  • Secured deposit accounts (SDA)
  • Credit accounts

These are described in the following table.

Account Type

Description

Deposit account

A deposit account is a standalone account with the ability to transfer funds in and out via a linked external account. It can also instantaneously move funds to any other type of account.

Secured deposit account

A security_deposit account, is an asset account that is used as collateral for credit. It also has the ability to move funds in and out via an external bank account, as well as perform account-to-account transfers for credit repayment. The SDA balance controls the credit limit provided by its linked credit account.

Credit Account

A credit account stores the credit owed and the credit limit of any outstanding loan or revolving credit line.

The Account object comprises two parts; the root object, which is all of the inherited structure across all accounts, and an object that specifies the type of account being used (credit, deposit, security_deposit).

The following example illustrates the base account object attributes.

{
    "account_id": "a2cbc90c-caeb-4137-8d95-3d1b64c10628",
    "date_updated": "2022-07-08T16:44:20.179543Z",
    "date_created": "2022-07-08T16:44:20.179543Z",
    "program_id": "84183869-461e-4e96-86b5-45b824aae569",
    "customer_id": "842ebd28-6d86-4d05-9630-b12cf9278875",
    "type": "deposit",
    "status": "active",
    "routing_number": "014175741",
    "account_number": "61286758183945",
    "description": "My First Deposit Account",
    "balance": {
        "previous_statement_balance": 97495,
        "available_balance": 97495,
        "current_balance": 97495,
        "currency": "USD"
    },
    "cards": [],
    "deposit": {}
}

The following table describes the attributes in the base account object.

Attribute

Description

account_id

The unique ID of the account.

date_updated

The last time the account object was updated.

date_created

The date and time the account was created.

program_id

The ID of the program that this account belongs to.

customer_id

The ID of the customer that this account belongs to.

type

The type of the account, for example deposit.

status

The status of the account, for example active.

routing_number

The routing number of the bank that hosts this account.

account_number

The bank account number.

description

A description of the account which is used as an alias for the account, such as "HSA Account" or "Tax Account".

balance.previous_statement_balance

The end balance of the previous statement. If there are no previous statements, this value is zero.

balance.available_balance

The balance available to the end user which includes any pending transactions.

balance.current_balance

The balance of all settled transactions.

balance.currency

The the currency of this account.

cards

The cards associated with this account.

Deposit accounts

A deposit account is our basic account type.

The following example illustrates the basic structure of a deposit account.

{
    "account_id": "a2cbc90c-caeb-4137-8d95-3d1b64c10628",
    "date_updated": "2022-07-08T16:44:20.179543Z",
    "date_created": "2022-07-08T16:44:20.179543Z",
    "program_id": "84183869-461e-4e96-86b5-45b824aae569",
    "customer_id": "842ebd28-6d86-4d05-9630-b12cf9278875",
    "type": "deposit",
    "status": "active",
    "routing_number": "014175741",
    "account_number": "61286758183945",
    "description": "My First Deposit Account",
    "balance": {
        "previous_statement_balance": 97495,
        "available_balance": 97495,
        "current_balance": 97495,
        "currency": "USD"
    },
    "cards": [],
    "deposit": {}
}

There are currently no attributes added to a deposit account, but notice that the type derives the name of the object with the model; "type": "deposit" and it's corresponding object is "deposit": {}"

Secured deposit accounts

The following example illustrates the basic structure of a secured deposit account.

{
  "account_id": "f7e98526-25e6-40ba-81e4-14ebc063a671",
  "date_updated": "2022-07-08T16:44:20.179543Z",
  "date_created": "2022-07-08T16:44:20.179543Z",
  "program_id": "ad6a3f0c-5012-4cf6-907b-85224e8a7919",
  "customer_id": "26700f58-dfcd-4a28-b9c3-1265b69df52c",
  "type": "security_deposit",
  "status": "active",
  "description": "",
  "routing_number": "547897762",
  "account_number": "574771265",
  "balance": {
    "current_balance": 50000,
    "ledger_balance": 50000,
    "currency": "USD"
  },
  "security_deposit": {
    "credit_account_id": "83312b92-8218-430f-a73a-cae35f93218b"
  }
}

Notice that the "type": "security_deposit" has a corresponding object; "type": "security_deposit": {}"`.

The following table describes the secured deposit account attribute.

Attribute

Description

security_deposit.credit_account_id

The credit account this secured deposit account is tied to.

Credit accounts

The following example illustrates the basic structure of a credit account.

{
  "account_id": "ed3dc85e-c3e8-4076-802f-56da7d5d66e2",
  "date_updated": "2022-07-08T16:44:20.179543Z",
  "date_created": "2022-07-08T16:44:20.179543Z",
  "program_id": "0adea755-90d3-47f4-9d44-4b73cbebaf3c",
  "customer_id": "db39e8e9-849d-435a-842c-7f4b3a49c5b3",
  "type": "security_deposit",
  "status": "active",
  "description": "string",
  "routing_number": "547897762",
  "account_number": "574771265",
  "balance": {
    "current_balance": 500,
    "ledger_balance": 500,
    "currency": "USD"
  },
  "security_deposit": {
    "credit_account_id": "182c3a25-69e8-4e16-b1bc-7211fcc2583d"
  }
}

Notice that the "type": "credit" has a corresponding object; "type": "credit": {}"`.

The following table describes the credit account attributes.

Attribute

Description

credit.credit_limit

The limit of the credit account.

credit.security_deposit_account_id

The security deposit account that this credit account is linked to.


Next Steps
Did this page help you?