FinancialInstitutionAccountModel

An Financial Institution Account represents an account used for monetary transactions. E.g. - checking, savings, or credit card accounts.

Methods

The following API methods use this data model.

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

financialInstitutionAccountId

uuid, read-only

The unique identifier for the Financial Institution Account.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single ADS Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

appEnrollmentId

uuid, nullable, read-only

The App Enrollment Id this Financial Institution is associated with.

created

date-time, read-only

The date the Financial Institution Account was created.

createdUserId

uuid, read-only

The user that has created the Financial Institution Account.

modified

date-time, read-only

The date the Financial Institution Account was modified.

modifiedUserId

uuid, read-only

The user that has modified the Financial Institution Account.

Optional Fields

bankAccountId

string, nullable, 0-255 characters

An alternate account id for the Financial Institution Account.

erpKey

string, nullable, 0-255 characters

The External Id for the Financial Institution Account.

name

string, nullable, 0-100 characters

The name of the Financial Institution Account.

status

string, nullable, 0-8 characters

The status of the Financial Institution Account. Possible values are active,
inactive, deleted or archived.

description

string, nullable, 0-500 characters

The description for the Financial Institution Account.

accountType

string, nullable, 0-10 characters

The classification for the Financial Institution Account. Possible values are Asset, Equity,
Expense, Liability or Income.