All fields apply to both merchant pricing and hierarchical pricing 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.
|
DDA Account Type The DDA Account Type is the type of account specified in the Fee DDA Override Fee DDA Override is used for the purpose of a particular fee being directed to a different DDA than the primary DDA used for funding. .
|
DdaAccountType
|
Cond.
|
Only required when Fee DDA Override field is populated
|
Fee DDA Override Fee DDA Override is used for the purpose of a particular fee being directed to a different DDA than the primary DDA used for funding.
|
DdaAccountOverride
|
N
|
|
Fee Transit Routing Override If the DDA is overridden (i.e. if a value is present in the Fee DDA Override Fee DDA Override is used for the purpose of a particular fee being directed to a different DDA than the primary DDA used for funding. ), the Fee Transit Routing Override routing number is needed to override the Transit Routing number set for the merchant.
|
TransitRouting
|
Cond.
|
Only required when Fee DDA field is populated.
|
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
|
|
 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.
|
Include in Monthly Minimum Fee Include in Monthly Minimum Fee is an indication of whether the fee will be included in a minimum discount comparison. For example an authorization fee item can be included with fee items in the Discount category and compared to an overall minimum discount of $20. If the calculated authorization plus the calculated discount equals $30, the minimum discount would not be applied. If the calculated authorization plus the calculated discount equals $19, the minimum discount of $20 would apply.
|
IncludeInMonthlyMinimum
|
N
|
This option is only available if the Overall Monthly Minimum option is turned on for the bank (i.e. if the bank subscribes to the Monthly Minimum service).
|
Sales Tax Indicator This setting is an indicator of whether sales tax is applied to this fee (for equipment, primarily, within the Misc Fixed fee category). This is an optional service. For clients using this option, they may specify which banks use this option and which do not during client implementation.
|
SalesTaxIndicator
|
N/A
|
This option is only available if the Sales Tax option is turned on for the bank. May only be used in the MISC Fixed category and with fee items having Equipment or Supplies set up in their key structures. If used with any other category or other key structures PPM will return an error.
|
Sales Tax Rate The Sales Tax Rate is the rate that is used if sales tax was applied to the fee in the previous month. This value is populated by the system, and is not user-entered.
|
SalesTaxRate
|
N
|
This value is system generated and should not be sent via XML. If it is sent, the file will be rejected.
|
Billing Method Billing Method determines how the merchant pays for a fee item. It is required for all fee items.
|
BillingMethodType
|
Yes
|
|
Name & Address Usage Code Name and Address Usage Code indicates which name and address record will be used for a particular fee. The merchant’s Discount (DIS) name and address record is most commonly used. However, if a fee should be directed to a statement that is mailed to a different address, specify the name and address usage code for the targeted address.
|
NameAddressUsageCode
|
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
|
|
Combine Code The Combine Code is an option to combine fee items on the merchant statement. For example, if a merchant has five authorizations fee items, setting this combine code to auth on all five items instructs the system to take all of these fees and bundle them into one line item on the merchant’s statement. The Statement Fee Description The Statement Fee Description is the description that will display on the merchant statement. If this field is used, one line, with this description, will display on the statement for the fee item. An alternative is to use the Display Detail on Statement Display Detail on Statement provides an option to break out the activity in one fee item and provide that detail on the merchant’s statement. This option must be selected if the client wants the merchant to see a description for each fee type within a fee item. This is a convenient feature to bundle many items for pricing (into one fee item), but unbundle on the merchant statement for reporting. setting. should be identical for each fee item included with a common Combine Code. If the descriptions are not identical, PPM selects one of the descriptions to display on the statement.
|
CombineCode
|
N
|
May not be used with the Display on Statement: Detail setting
|
Statement Fee Description The Statement Fee Description is the description that will display on the merchant statement. If this field is used, one line, with this description, will display on the statement for the fee item. An alternative is to use the Display Detail on Statement Display Detail on Statement provides an option to break out the activity in one fee item and provide that detail on the merchant’s statement. This option must be selected if the client wants the merchant to see a description for each fee type within a fee item. This is a convenient feature to bundle many items for pricing (into one fee item), but unbundle on the merchant statement for reporting. setting.
|
StatementFeeDescription
|
Cond.
|
May not be used with Display on Statement: Detail setting. Required if not using Display on Statement Detail field.
Note: A value sent in this field will produce an error and the Display Detail tag is Yes, the fee item will be rejected.
|
Display on Statement: Detail Display Detail on Statement provides an option to break out the activity in one fee item and provide that detail on the merchant’s statement. This option must be selected if the client wants the merchant to see a description for each fee type within a fee item. This is a convenient feature to bundle many items for pricing (into one fee item), but unbundle on the merchant statement for reporting.
|
DisplayDetail
|
N
|
May not be used with Statement Fee Description or Combine Code.
|
Display on Statement: Count Display on Statement: Count provides an option to display on the merchant statement the total number of items used to calculate the fee. For example, using this setting would display how many authorization transactions a merchant had for a particular auth fee.
|
DisplayCount
|
N
|
|
Display Rates on Statement Display Rates on Statement provides an option to display the rates for a particular fee item on the merchant’s statement. It will display Per Item ($) and Percent rates for Per Item, Percent, Pass Through and Tiered pricing. Rates applied over and above the Pass Through Rates will be combined into the Percent and Per Item ($) rates displayed.
|
DisplayRate
|
N
|
May be used with Per Item ($), Expense Per Item and Pass Through Expense. If the rate is negative it will display as negative on the statement.
|
Count (User Entered)
For Miscellaneous Fixed fees, a Count may be entered along with the fixed rate. This field acts as a multiplier, causing the fixed rate in the Per Item ($) amount field to act as a true per item rate.
Note: The Count field can accept a numeric value (1-999999) or can be left blank. However, if a zero (0) is entered, the calculation will be performed as if it is a one (1).
For example, a merchant may rent three terminals at $30 per month each, for a total of $90. The client may combine these terminals in one fee item, using the Count value to indicate how many terminals are rented. The Per Item ($) amount ($30) indicates the cost per terminal, providing a detailed display on the statement. The system will then calculate a total of $90.
Note: For complete reporting to the merchant, also select Display on Statement: Count Display on Statement: Count provides an option to display on the merchant statement the total number of items used to calculate the fee. For example, using this setting would display how many authorization transactions a merchant had for a particular auth fee. and Display Rate on Statement Display Rates on Statement provides an option to display the rates for a particular fee item on the merchant’s statement. It will display Per Item ($) and Percent rates for Per Item, Percent, Pass Through and Tiered pricing. Rates applied over and above the Pass Through Rates will be combined into the Percent and Per Item ($) rates displayed..
|
Count
|
N
|
May not be used with Pass Through Expense.
|
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 be used with Expense Per Item (for MISC fixed fees only) and/or Pass Through Expense.
|
Expense Per Item ($) Expense Per Item ($) may be used to add an expense directly on the merchant profile or hierarchy profile for a particular fee item or fee items in the Miscellaneous Fixed category, with no dependency on the merchant’s ERG.
|
ExpensePerItem
|
N
|
May be used with Per Item ($) and Pass Through Expense.
|
Pass Through Expense The Pass Through Expense rate method allows the user to pass 100% of an acquirer’s expense fee directly to the merchant. Since the rate is managed in the ERG and not the individual merchant profile, this allows the client to update an expense (when the expense changes) in one place and affect all of the merchants that use the pass through expense method automatically.
|
PassThroughExpense
|
Cond.
|
At least one rate method must be chosen per fee item. An ERG that contains this fee item must exist or be sent and set as the ERG for this merchant profile before this rate method may be chosen for an income fee item. The Fee Item Name and key structure of the pricing fee item must exactly match the corresponding fee item in the ERG. May be used with Expense Per Item (for MISC fixed fees only) and/or Per Item ($). May not be used with Count.
|
Lock Settings – Hierarchy Profiles Only
|
Fee Item Rate Lock The Fee Item Rate Lock applies to hierarchy profiles only. This field is not available for merchant profiles or ERGs.
|
RateLock
|
N
|
For hierarchy profiles only – may set for Per Item and Pass Through Expense rates.
|
Fee Item Rate Range Max The Fee Item Rate Range: Maximum applies to hierarchy profiles only. This field is not available for merchant profiles or ERGs.
|
Max
|
N
|
For hierarchy profiles only – may set for Per Item and Pass Through Expense rates.
|
Fee Item Rate Range Min The Fee Item Rate Range: Minimum applies to hierarchy profiles only. This field is not available for merchant profiles or ERGs.
|
Min
|
N
|
For hierarchy profiles only – may set for Per Item and Pass Through Expense rates.
|
Fee Item Rate Range Lock The Fee Item Rate Range Lock (that is, the restriction of the allowable range of values for this fee item) applies to hierarchy profiles only. This field is not available for merchant profiles or ERGs.
|
RangeLock
|
N
|
For hierarchy profiles only – may set for Per Item and Pass Through Expense rates.
|
