API Reference

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.

FieldTypeRequirementsDescription
idString
openDateStringISO 8601 as YYYY-MM-DD
nameStringDisplay name of the account
relationshipsList of Relationship Object(s)See the Relationship object
typeEnumCONSUMER, COMMERCIAL
productCategoryEnumCHECKING, SAVINGS, TIMEDEPOSIT
productSubCategoryStringDefined by the bank, usually a customer facing name for a product, e.g. "Gold Checking Account"
currentBalanceDoubleThis value is always in USD
availableBalanceDoubleThis value is always in USD
interestRateDoubleExpressed as a percentage. E.g. 8.75 represents "8.75%"Applicable for TIMEDEPOSIT accounts. Other accounts will be 0.
interestMethodEnumVARIABLE, FIXED, ADJUSTABLE, FLOATING
securedNullable BooleanApplicable for TIMEDEPOSIT accounts, otherwise null.
maturityDateNullable StringISO 8601 as YYYY-MM-DDApplicable for TIMEDEPOSIT accounts, otherwise null.
termNullable IntegerTerm length, in months. Applicable for TIMEDEPOSIT accounts, otherwise null.
notesString
originatingBranchStringInternal identifier, specific to core/bank
originatingCostCenterStringInternal identifier, specific to core/bank