The Deposit Account Object
{
"id": "987654321",
"name": "John Doe Checking Account",
"relationships": [
{
"id": "REL123",
"name": "Jane Doe",
"type": "CO-SIGNER"
},
{
"id": "REL124",
"name": "Acme Corporation",
"type": "AUTHORIZED USER"
}
],
"type": "CONSUMER",
"productCategory": "CHECKING",
"productSubCategory": "Standard Checking",
"currentBalance": 1250.75,
"availableBalance": 1200.50,
"interestRate": 0.25,
"interestMethod": "FIXED",
"secured": false,
"maturityDate": null,
"term": null,
"notes": "Account opened with a promotional offer. No overdraft protection.",
"openDate": "2022-03-15",
"originatingBranch": "B002",
"originatingCostCenter": "CC00123"
}
Some fields have specific requirements, which are detailed below.
Field | Type | Requirements | Description |
---|---|---|---|
id | String | ||
openDate | String | ISO 8601 as YYYY-MM-DD | |
name | String | Display name of the account | |
relationships | List of Relationship Object(s) | See the Relationship object | |
type | Enum | CONSUMER, COMMERCIAL | |
productCategory | Enum | CHECKING, SAVINGS, TIMEDEPOSIT | |
productSubCategory | String | Defined by the bank, usually a customer facing name for a product, e.g. "Gold Checking Account" | |
currentBalance | Double | This value is always in USD | |
availableBalance | Double | This value is always in USD | |
interestRate | Double | Expressed as a percentage. E.g. 8.75 represents "8.75%" | Applicable for TIMEDEPOSIT accounts. Other accounts will be 0 . |
interestMethod | Enum | VARIABLE, FIXED, ADJUSTABLE, FLOATING | |
secured | Nullable Boolean | Applicable for TIMEDEPOSIT accounts, otherwise null . | |
maturityDate | Nullable String | ISO 8601 as YYYY-MM-DD | Applicable for TIMEDEPOSIT accounts, otherwise null . |
term | Nullable Integer | Term length, in months. Applicable for TIMEDEPOSIT accounts, otherwise null . | |
notes | String | ||
originatingBranch | String | Internal identifier, specific to core/bank | |
originatingCostCenter | String | Internal identifier, specific to core/bank |