Account
An account is a bank account managed by Helix belonging to a customer. To correlate a specific account in Helix to a specific account item in your system, use the tag
property. An account is in contrast to an external account which is a customer bank account managed by a different financial institution.
Take me to the Account Endpoint Reference
account Object
Property | Data Type (length) | Description |
---|---|---|
| enum | The type of access the
|
| decimal | Total balance of account, including funds that have holds placed on them. Represents all settled transactions on the account to date. This is the balance used for interest accrual calculations, if this is an interest-bearing account. |
| integer | Helix-assigned unique ID for the account |
| decimal | Lowest dollar amount the account can be overdrawn
|
| string (50) | Bank account number
|
| string | Masked version of |
| decimal | Balance available for immediate withdrawal. Settling a transaction for a DDA account will typically credit the |
| datetime | Most recent date any of the following were altered in any way:
|
| string (50) | Freeform text for grouping accounts. Useful for grouping and trending in reports. |
| datetime | Date the account was closed |
| datetime | Date the account was created |
| string (50) | A property for holding client-defined data. There is no business logic in Helix for a custom field. |
| string (50) | A property for holding client-defined data. There is no business logic in Helix for a custom field. |
| string (50) | A property for holding client-defined data. There is no business logic in Helix for a custom field. |
| string (50) | A property for holding client-defined data. There is no business logic in Helix for a custom field. |
| string (50) | A property for holding client-defined data. There is no business logic in Helix for a custom field. |
| integer | Helix-assigned unique ID for of the customer who owns the account. |
| integer | The priority of ownership the customer has for the account. Primary owner always has a |
| datetime | The date and time the first credit transaction settled on the account. Example: |
| boolean |
|
| boolean | Indicates whether the account can be closed via /account/close. This property is assignable only at account creation time and cannot be updated. |
| boolean |
|
| boolean |
|
| boolean | Indicates whether the account is the primary account for the customer. Read-only. Automatically set when account is created. |
| boolean |
|
| datetime | Date when the account was last altered in any way (excluding the balance properties -- see |
| string (100) | Primary legal name used to identify the account |
| string (100) | Secondary legal name used to identify the account (or a continuation of legalName1 if more characters are needed) |
| enum | Reason the lock was applied to the account
|
| enum | Type of account lock
|
| string (50) | A caller-specified, user-friendly name for this account. Must be unique within a given customer . |
| decimal | Balance of pending deposit transactions. When a pending deposit transaction settles, it will debit this balance. Deposit transactions, which settle immediately, will never affect this balance. |
| integer | The identification number of the primary owner for the account. By default, this is the |
| integer | The Helix-assigned unique ID of the product to which this account is associated. Configured products can be found on the |
| decimal | The amount to contribute on a recurring basis. |
| datetime | The earliest date on which future recurring contributions should end. Must be greater than the |
| integer | The |
| datetime | The date the next recurring contribution is scheduled to occur. This property is read-only, but setting |
| datetime | The earliest date on which future recurring contributions should start. Note if the day specified is less than or equal to "tomorrow", the first recurring contribution will occur the following period. So if today is the 8th and a value between 1 and 9 is specified, the first recurring contribution will happen the following period. If a value between 10 and 28 is specified, the first recurring contribution will happen during the current period. The value for the day portion of the date must be between 1 and 28. |
| enum | The frequency with which recurring contributions occur. Possible values:
|
| integer | Count of withdrawals on a Savings product with RegD Fee enabled for current month. Increments per withdrawal transaction and if needed, based on product configuration, will create a single Fee transaction at month-end. |
| string | Routing Transit Number (RTN) is a nine-digit bank code used to identify the financial institution where bank account is held. Read-only. |
| string | Masked version of |
| array | Reserved for future use |
| enum | Account status Valid values include:
|
| string (50) | Freeform text for grouping accounts. Useful for grouping and trending in reports. |
| string (50) | A caller-specified, unique identifier for this account. Must be unique within your program. |
| decimal | Amount the customer wants the |
| datetime | Date on which the customer would like the |
| array | Reserved for future use |
| datetime | The first date the |
| decimal | The percent of progress towards reaching the |
| integer | The total number of customers with some type of access to the account. |
| enum | The type of the product associated with the account via
|
*Property relates to Recurring Contribution functionality. This is an optional feature that must be enabled by Q2 and requires an additional subscription fee.
**Property relates to joint account functionality. Use of joint account functionality requires approval from your bank partner.
Updated 16 days ago