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

Property

Data Type (length)

Description

accounts

array

An array of programAccount objects.

bank

bank object

Information about the program's partner bank

bins

array

An array of bin objects.

checkingProducts

deprecated

Filter by type=Checking in
the products array.

decimalCount

integer

Number 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.

eCodeProducts

deprecated

deprecated

externalAccounts

array

An array of programExternalAccount objects.

filledDate

datetime

Date 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.

isDebitRewardsEnabled

boolean

true if the program has a debit rewards integration enabled

isInterestEnabled

deprecated

Interest is enabled or
disabled on a per-product basis.

isInternalToInternalTransferEnabled

boolean

true if transferring funds between two
Helix accounts is allowed, false
otherwise.
Note: both accounts must be owned
by the same customer.

isRecurringContributionEnabled

boolean

true if the recurring contribution feature
is enabled for your program.
false otherwise.

name

string

The name of your program.

perProgramDailyDepositLimit

limit object

The 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.

perProgramDailyWithdrawLimit

limit object

The 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.

perTransactionDepositLimit

limit object

The minimum and maximum amount allowed that
can be deposited in a single transaction.

perTransactionWithdrawLimit

limit object

The minimum and maximum amount allowed that
can be withdrawn in a single transaction.

perUserAccountCountMax

integer

The maximum number of accounts a single customer can have

perUserDailyDepositLimit

limit object

The minimum and maximum amount of all
deposits that can be performed on a single
day across all accounts for a given
customer.

perUserDailyWithdrawLimit

limit object

The minimum and maximum amount of all
withdrawals that can be performed on a
single day across all accounts for a given
customer.

perUserExternalAccountCountMax

integer

Maximum number of active externalAccounts
a customer can have at once.

perUserMonthlyDepositLimit

limit object

The minimum and maximum amount of all
deposits that can be performed during a
single month across all accounts for a given
customer.

perUserMonthlyWithdrawLimit

limit object

The minimum and maximum amount of all
withdrawals that can be performed during a
single month across all accounts for a given
customer.

perUserTotalAccountBalanceMax

integer

The maximum dollar balance a customer can have across all of their accounts

prepaidProducts

deprecated

Filter by type=Prepaid in
the products array.

products

array

An array of product objects.

publicKeyAlgorithms

string

The 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.

regDFeeAmount

decimal

The 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.

regDMonthlyTransactionWithdrawCountMax

integer

The number of withdrawals per month across
all accounts with type=Savings for a given
customer before the regDFeeAmount is
applied.

savingsProducts

deprecated

Filter by type=Savings in
the products array.

timeZone

string

The timezone all dates will be recorded in.

validAccountTypes

deprecated

Use the products array.

validProductTypes

deprecated

Use the products array.

verificationType

enum

The type of verification required when
creating a new customer. Possible values:

  • None
  • OFAC Only
  • Full

website

string

The url associated with your program.
Informational only.