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.
Take me to the Program Endpoint Reference
|Data Type (length)
|An array of programAccount objects.
|Information about the program's partner bank
|An array of bin objects.
type=Checking in the
|Number of significant digits to the right of the decimal for all monetary properties. Will always be a value between
4. Does NOT apply to interest rate properties.
|An array of programExternalAccount objects.
|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.
true if the program has a debit rewards integration enabled
|Interest is enabled or disabled on a per-product basis.
true if transferring funds between two Helix accounts is allowed,
Note: both accounts must be owned by the same customer.
true if the recurring contribution feature is enabled for your program.
|The name of your program.
|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.
|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.
|The maximum amount that can be deposited to an account via /transfer/create in a single transaction.
|The maximum amount allowed that can be withdrawn in a single transaction.
|The maximum number of accounts a single customer can have
|The maximum amount of all deposits that can be performed in a day for a single account.
|The maximum amount of all withdrawals that can be performed in a day for a single account.
|Maximum number of active externalAccounts a customer can have at once.
|The maximum amount of all deposits that can be performed during a month for a single account.
|The minimum and maximum amount of all withdrawals that can be performed during a month for a single account.
|The maximum dollar balance a customer can have across all of their accounts
type=Prepaid in the
|The array of products offered by your program.
|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.
|The fee amount to apply to all withdrawal transactions for a given customer after the limit defined by
regDMonthlyTransactionWithdrawCountMax . Applies only to accounts with
|The number of withdrawals per month across all accounts with
type=Savings for a given customer before the
regDFeeAmount is applied.
type=Savings in the
|The timezone all dates will be recorded in.
|Verification requirements are now configured on a per product basis.
|The url associated with your program. Informational only.
Updated 3 months ago