All fields apply to both ERGs and RP ERGs unless specifically indicated otherwise.
Full Name
|
Field Name
|
Req’d
|
Business Rules
|
Start Date The Start Date is the date a fee item becomes active and is applied. The Start Date cannot be in the past when updating existing fee items. The fee item will start processing from the Start Date. If the fee item is saved on a profile, ERG or RP ERG with a date in the future, even though it is not currently being applied, it counts toward the overall "active" fee limit for that profile, ERG or RP ERG.
|
StartDate
|
Yes
|
|
Stop Date The Stop Date is the date after which a fee item expires. This date may be used to mark the end of the application of this fee item, or to stop the current rate and begin the next rate, if using the effective rate features in the Date Rate tag (located within the Pricing tag).
|
StopDate
|
N
|
Must be after start date.
|
Frequency Frequency is a setting to indicate when this fee item applies. This can be all months, or specific months. Each month is a separate three-letter tag: Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
|
FrequencyType
|
Yes
|
|
GL Item Code The GL Item Code can be used to group certain types of fee items for GL or other reporting purposes. This setting may be used in profiles and ERGs to differentiate between income and expense items. The client may then access profitability totals by his GL Item Code Values.
|
GLItemCodeType
|
N
|
|
User Data Code The User Data Code can be used to label groups of fee items for certain merchants with a client-defined value for reporting, searching and possible re-pricing at a later time. For example, a client may want to group pricing for hotels, or gas stations, or retail into different auth rates. The client may then access profitability totals by his User Data Code Values.
|
UserDataCodeType
|
N
|
|
 Align to Seasonal Billing
A fee item level indicator that will, if a merchant is seasonal with seasonal months, align the fee item billing frequency to be that of the merchant's seasonal months. This is completed when the fee item is added to the merchant profile, when a fee item is modified, or when a merchant's seasonal settings are established or modified.
For example, a merchant that has billing frequency established as September through March submits a request; fees containing a Y for SeasonalIndicator will set the fee item to have a billing frequency of September through March. If the merchant's billing frequency months are changed, the fee item's billing frequency months will also be changed.
|
AlignToSeasonalBilling
|
N
|
May not be used with IRG and Hierarchy Fee Items.
|
Per Item ($) Per Item ($) is a rate to be charged on a per item basis (dollar amount), calculated against the total number of transactions defined in each fee item. It is considered a rate method. It may be used alone as the only rate method, or combined with other rate methods, depending on which fee category is used.
|
PerItem
|
Cond.
|
At least one rate method must be chosen per fee item. May not be used with Volume Tiers.
|
Agent (%) On Fee Agent % on Fee is the percentage of the fee that the agent will pay to the next agent in the hierarchy.
|
AgentFeePercent
(RP ERG Only)
|
Cond.
|
May be used with Per Item or Volume Level Tiers.
|
Tier Type Tier Type is a pricing method allowing different rates for different levels of activity, whether tiered by overall volume for the month.
|
TierType
|
Cond.
|
At least one rate method is required in each fee item. May only use Volume Tiers. May not be used with Per Item. May be used with Agent (%) on Fee.
|
Volume Tier Method Volume Tier Method determines the manner in which transactions are assigned to a particular tier. For Volume Tiers only.
|
VolumeTierMethod
|
Cond.
|
Required only if Volume Tier Type is selected.
|
Volume Tier Based On Volume Tier Based On determines which aspect of the transactions will used for determining the proper tier assignment. For Volume Tiers only.
|
VolumeTierBasedOn
|
Cond.
|
Required only if Volume Tier Type is selected. May only use Number. May not use Amount.
|
Tier Min Factor The Tier Minimum Factor is the lowest value for each tier.
|
MinFactor
|
Cond.
|
Required only if Volume Tier Type is selected. Required for each tier. A tiered fee item must have at least two tiers and no more than nine tiers.
|
Tier Max Factor The Tier Maximum Factor is the highest value for each tier. This is a calculated field based on the previous tier's minimum. It is not to be sent in XML.
|
MaxFactor
|
|
Note: Max Factor is calculated by the system based on Min Factor. If it is sent via XML it is ignored.
|
Tier Fee Per Item ($) is a rate to be charged on a per item basis (dollar amount), calculated against the total number of transactions defined in each fee item. It is considered a rate method. It may be used alone as the only rate method, or combined with other rate methods, depending on which fee category is used.
|
PerItem
|
Cond.
|
Per Item is required if Volume Tier Type is selected. Required for each tier.
Note: While Percent is available in the schema, it will fail in processing and should not be used.
|
