Fee

Fee objects represent the configuration and results of fees managed by the Helix fee engine. Fee configurations define the rules and amounts for fees applicable to a program, while fee results capture the outcome of a fee application.

feeConfiguration Object

Represents a fee rule configured for a program. Returned as an array by GET /fee/config/list.

PropertyData typeDescription
amountdecimalFee amount. Value of 0.00 indicates a variable amount will be passed for the fee.
descriptionstring (100)Description of the fee rule.
feeAccountBalanceRuleTypeenumIdentifies how the fee will be applied based on account balance. Valid values include: AllowNegativeToProductSetting, BalanceToZero
feeAmountTypeenumIndicates how the fee is applied. Valid values include: MonetaryAmount, PercentageOfTransactionAmount, FeeRuleDefinitionOutput
feeCodestring (3)Rule type value.
feeGroupDescriptionstringClient-defined description of feeGroupTitle.
feeGroupTitlestringClient-defined group name to categorize various fees.
feeTypeIdintegerHelix-assigned fee rule identifier.
productIdintegerHelix-assigned unique ID of the product to which the account is associated.
productNamestringName of the product.
productTypeenumIndicates the product type. See products on the program object for valid values.
productTypeIdintegerHelix-assigned unique ID of the product type associated with the account.

feeResult Object

Represents the result of a fee application.

PropertyData typeDescription
feeAmountdecimalAmount of funds the fee transaction represents.
feeToApplyIdlong integer (64-bit)Helix-assigned unique ID used to relate the fee applied to the fee transaction.
feeTypestring (50)Client-specified description of the fee transaction.
tagstring (128)Client-defined unique identifier for tracking or reconciliation.