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.
| Property | Data type | Description |
|---|---|---|
amount | decimal | Fee amount. Value of 0.00 indicates a variable amount will be passed for the fee. |
description | string (100) | Description of the fee rule. |
feeAccountBalanceRuleType | enum | Identifies how the fee will be applied based on account balance. Valid values include: AllowNegativeToProductSetting, BalanceToZero |
feeAmountType | enum | Indicates how the fee is applied. Valid values include: MonetaryAmount, PercentageOfTransactionAmount, FeeRuleDefinitionOutput |
feeCode | string (3) | Rule type value. |
feeGroupDescription | string | Client-defined description of feeGroupTitle. |
feeGroupTitle | string | Client-defined group name to categorize various fees. |
feeTypeId | integer | Helix-assigned fee rule identifier. |
productId | integer | Helix-assigned unique ID of the product to which the account is associated. |
productName | string | Name of the product. |
productType | enum | Indicates the product type. See products on the program object for valid values. |
productTypeId | integer | Helix-assigned unique ID of the product type associated with the account. |
feeResult Object
Represents the result of a fee application.
| Property | Data type | Description |
|---|---|---|
feeAmount | decimal | Amount of funds the fee transaction represents. |
feeToApplyId | long integer (64-bit) | Helix-assigned unique ID used to relate the fee applied to the fee transaction. |
feeType | string (50) | Client-specified description of the fee transaction. |
tag | string (128) | Client-defined unique identifier for tracking or reconciliation. |
Updated 6 days ago
