The Account object

View is an account with its balances and product.

Attributes

balancesobjectRequired

Balances of an account.

7 child attributes

available_amountintegerRequired

currency_codestringRequired

holding_amountintegerRequired

last_activity_datestring · date or nullOptional

The customer's last movement; dormancy counts from here

ledger_amountintegerRequired

locked_amountintegerRequired

pending_amountintegerRequired

certificateobject or nullOptional

CertificateTerms are a certificate account's contract.

8 child attributes

at_maturitystringRequired

Rollover or pay_out

grace_daysintegerRequired

maturedbooleanRequired

maturity_datestring · dateRequired

A business date, YYYY-MM-DD

penalty_daysintegerRequired

renewalsintegerRequired

rollover_product_codestringOptional

term_monthsintegerRequired

closed_atstring · date-time or nullOptional

currency_codestringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

default_account_numberstringRequired

default_account_number_idstringRequired

Example acno_2tVh8nqLxq4GbDe0K1F6S9zRcWm

descriptionstringRequired

idstringRequired

interest_planbooleanRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

now_eligibility_idstringOptional

opened_atstring · date-timeRequired

ownersarray of stringsRequired

ownershipobjectRequired

Ownership is how an account is titled, apart from who its owners are.

11 child attributes

beneficiariesarray of objectsOptional

5 child attributes

customer_idstringOptional

The customer record carrying the beneficiary's TIN (required for utma and custodial)

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

date_of_birthstringOptional

namestringRequired

relationshipstringOptional

share_bpsintegerRequired

custodianstringOptional

decedentstringOptional

fiduciarystringOptional

firmstringOptional

ira_typestringOptional

survivorshipbooleanOptional

tax_reportingstringOptional

Derived: how the interest is reported

trust_namestringOptional

trusteesarray of stringsOptional

typestringRequired

Individual, joint, pod, trust, estate, utma, iolta, hsa, ira, custodial

ownership_recorded_atstring · date-time or nullOptional

ownership_revisionintegerOptional

Zero means unknown legacy chronology

productobjectRequired

product_codestringRequired

product_versionintegerRequired

restrictionsobjectRequired

Restrictions are the rules a payment or a card must respect before money leaves the account.

5 child attributes

certificateobject or nullOptional

CertificateStatus is where a certificate stands today.

11 child attributes

at_maturitystringRequired

Rollover or pay_out

grace_daysintegerRequired

grace_endsstring · dateRequired

A business date, YYYY-MM-DD

in_gracebooleanRequired

maturedbooleanRequired

maturity_datestring · dateRequired

A business date, YYYY-MM-DD

penalty_daysintegerRequired

renewalsintegerRequired

rollover_product_codestringOptional

term_monthsintegerRequired

withdrawablebooleanRequired

debit_blockedbooleanRequired

reasonstringOptional

transfer_limitobject or nullOptional

TransferLimitStatus is where an account stands against its product's convenient-transfer limit in the current statement cycle.

6 child attributes

cyclestringRequired

enforcementstringRequired

Refuse or fee

excess_fee_amountintegerRequired

per_cycleintegerRequired

remainingintegerRequired

usedintegerRequired

withdrawablebooleanRequired

routing_numberstringRequired

statement_cyclestringRequired

statusstringRequired

status_reasonstringOptional

typestringRequired