Type of account. If provided, accountSubType must also be provided.
Valid deposit subtypes: Checking, Savings, CD, Money Market, Pseudo.
Valid loan subtypes: Credit Card, Heloc, Line of Credit.
Enum:"Deposit""Loan"
accountSubType
string
Sub-account type. The values "MoneyMarket" and "LineofCredit" are deprecated.
Use "Money Market" and "Line of Credit" instead.
Enum:"Checking""Savings""Health Savings Account""CD""MoneyMarket""LineofCredit""Money Market""Pseudo""Credit Card""Heloc""Line of Credit"
systemOfRecords
string
System of records.
Enum:"Other Core""External"
accountNumber
string^[A-Za-z0-9]+$
Bank account number. This an unique value in the finzly db.
currency
string
Currency of the account
accountName
string
Bank account name.
masterGl
string
Master GL number.
enableOffset
string
Enable offset account
Enum:"Yes""No"
enableWire
string
Enable or Disable for the wire transaction
Enum:"Yes""No"
defaultOffset
string
Indicates whether the account is the default offset account.
Possible values are 'Yes' or 'No'.
If no account exists for the given achCompanyId and it is unique, the system will automatically set the default offset value to 'Yes'.
Enum:"Yes""No"
feeAccount
string
Whether the accountNumber is a Fee account
Enum:"Yes""No"
returnAccount
string
Whether the accountNumber is a Return account
Enum:"Yes""No"
fboAccountNumber
string^[A-Za-z0-9]+$
The fbo account number should be associated with legal entity.
countryCode
string
ISO country code
routingNumber
string
Valid routing number/bankId
bankIdType
string
Bank identifier type
Enum:"NID""BIC"
enableCallbacks
boolean
Enable call backs. It is an optional field. The Possible values are true/false.
callbackLimit
number <double> [ 0 .. 999999999.99 ]
Call back limit. Not allowed when accountSubType is Pseudo.
costCenter
string
Cost Center associated with the customer entity
isUnderWritten
boolean
Indicates whether the account allows underwriting.
This is an optional field with possible values true or false.
This field is mutually exclusive with isAchPrefund.
isAchPrefund
boolean
ACH Prefunding is a practice that ensures the account has sufficient funds for ACH Credit payments. It is an optional field. The Possible values are true/false.
debitExposureLimit
number <double> >= 0
Maximum allowed amount for debit transfers for prefunded ACH accounts. Must be a positive value.
creditExposureLimit
number <double> >= 0
Maximum allowed amount for credit transfers for prefunded ACH accounts. Must be a positive value.
accountAnalysis
boolean
Account analysis status.
reason
string <= 255 characters
Optional note or reason for the update.
secCodes
Array of strings
Provide all valid SEC-Standard Entry Class codes allowed for the given customer entity. e.g. WEB,CCD,PPD,TEL,IAT, etc..
achCompanyId
string <= 10 characters
ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)
object (AccountFeatures)
Array of objects (AdditionalAttribute)
An optional list of additional account attributes.
Responses
200
OK
400
Bad request
401
You are not authorized to access the resource
403
Accessing the resource you were trying to reach is forbidden
404
The resource you were trying to reach is not found