The program object represents your business on Helix and contains settings and info that applies to all your customers, accounts, externalAccounts, transactions etc. The program object also contains info for all the products you are offering through Helix. All values are read-only. Please contact [email protected] or your relationship manager to make any changes.


program Object

PropertyData Type (length)Description
accountsarrayAn array of programAccount objects.
bankbank objectInformation about the program's partner bank
binsarrayAn array of bin objects.
checkingProductsdeprecatedFilter by type=Checking in the products array.
decimalCountintegerNumber of significant digits to the right of the decimal for all monetary properties. Will always be a value between 0 and 4. Does NOT apply to interest rate properties.
eCodeProductsdeprecateddeprecated
externalAccountsarrayAn array of programExternalAccount objects.
filledDatedatetimeDate the program values were last refreshed from the database. For performance reasons, they are cached for up to 5 minutes. i.e. if changes are made to any of these settings via the Helix Admin Console, it will take up to 5 minutes for them to propagate to the Helix API.
isDebitRewardsEnabledbooleantrue if the program has a debit rewards integration enabled
isInterestEnableddeprecatedInterest is enabled or disabled on a per-product basis.
isInternalToInternalTransferEnabledbooleantrue if transferring funds between two Helix accounts is allowed, false otherwise.
Note: both accounts must be owned by the same customer.
isRecurringContributionEnabledbooleantrue if the recurring contribution feature is enabled for your program.false otherwise.
namestringThe name of your program.
perProgramDailyDepositLimitlimit objectThe minimum and maximum amount of the sum of all deposits that can be performed on a single day across all accounts and all customers within your program.
perProgramDailyWithdrawLimitlimit objectThe minimum and maximum amount of the sum of all withdrawals that can be performed on a single day across all accounts and all customers within your program.
perTransactionDepositLimitlimit objectThe minimum and maximum amount allowed that can be deposited in a single transaction.
perTransactionWithdrawLimitlimit objectThe minimum and maximum amount allowed that can be withdrawn in a single transaction.
perUserAccountCountMaxintegerThe maximum number of accounts a single customer can have
perUserDailyDepositLimitlimit objectThe minimum and maximum amount of all deposits that can be performed on a single day across all accounts for a given customer.
perUserDailyWithdrawLimitlimit objectThe minimum and maximum amount of all withdrawals that can be performed on a single day across all accounts for a given customer.
perUserExternalAccountCountMaxintegerMaximum number of active externalAccounts a customer can have at once.
perUserMonthlyDepositLimitlimit objectThe minimum and maximum amount of all deposits that can be performed during a single month across all accounts for a given customer.
perUserMonthlyWithdrawLimitlimit objectThe minimum and maximum amount of all withdrawals that can be performed during a single month across all accounts for a given customer.
perUserTotalAccountBalanceMaxintegerThe maximum dollar balance a customer can have across all of their accounts
prepaidProductsdeprecatedFilter by type=Prepaid in the products array.
productsarrayThe array of products offered by your program.
publicKeyAlgorithmsstringThe list of algorithms approved for use by your program needed by any public key encryption required by the API. See program.publicKeyAlgorithms for more details.
regDFeeAmountdecimalThe fee amount to apply to all withdrawal transactions for a given customer after the limit defined by regDMonthlyTransactionWithdrawCountMax . Applies only to accounts with type=Savings.
regDMonthlyTransactionWithdrawCountMaxintegerThe number of withdrawals per month across all accounts with type=Savings for a given customer before the regDFeeAmount is applied.
savingsProductsdeprecatedFilter by type=Savings in the products array.
timeZonestringThe timezone all dates will be recorded in.
validAccountTypesdeprecatedUse the products array.
validProductTypesdeprecatedUse the products array.
verificationTypedeprecatedVerification requirements are now configured on a per product basis.
websitestringThe url associated with your program. Informational only.