confirm_surcharge_incl_config_params
Configuration Parameters
Merchant.PurchaseSurchargeEnabled
Surcharge may be applied to Purchase (+ Cash + Tip) transactions if this is enabled.
Merchant.ContactlessSurchargeEnabled
In addition to Merchant.PurchaseSurchargeEnabled, when this is enabled, surcharge may be applied to Contactless transactions.
Merchant.CashOutOnlySurchargeEnabled
Surcharge may be applied to Cash Only transactions if this is enabled.
Merchant.MotoSurchargeEnabled
Surcharge may be applied to MOTO transactions if this is enabled.
Merchant.PreauthCompletionSurchargeType
Surcharge may be applied to Pre-Auth/Completion transactions as configured.
Merchant.SurchargeConfirmationRequired
Indicates whether the surcharge amount must be confirmed by the customer after it has been calculated during EMV Chip and other non-Contactless transactions.
Merchant.SurchargeConfirmationRequiredCtls
Indicates whether the surcharge amount must be confirmed by the customer after it has been calculated during Contactless transactions.”
Merchant.SurchargeConfirmationTimeoutBehavior
Defines how the terminal will behave when the surcharge confirmation screen times out.
0 - Cancel Transaction
1 - Accept and proceed with transaction flow
2 - Beep and re-prompt (this behavior is always used in Accessibility mode)
Merchant.DisplaySurchargeConfirmationNotice
When enabled, a textual notice message will be displayed on the customer surcharge confirmation prompt.
Terminal.SurchargeConfirmationTimeout
The time in seconds that the surcharge confirmation screen will be displayed, before it is automatically dismissed.
MerchantSurcharge.MerchantId
Identifies the merchant to which the surcharge settings apply to.
MerchantSurcharge.ProductId
Identifies the card product to which the surcharge settings apply to.
MerchantSurcharge.UseDomesticConfigForInternational
When enabled, surcharging of transactions that utilize international payment methods follows the same rules as transactions utilizing domestic payment methods. The international configuration variants (below) are ignored. When disabled, unique International configuration parameters will control surcharging of transactions that utilize international payment methods.
MerchantSurcharge.SurchargeType / MerchantSurcharge.SurchargeTypeInternational
Specifies the type of surcharge to apply; one of: Not`` ``Configured`` ``:`` ``0, Fixed`` ``Amount`` ``:`` ``1, Percentage`` ``:`` ``2.
MerchantSurcharge.SurchargeValue / MerchantSurcharge.SurchargeValueInternational
Specifies the value of the surcharge depending on the surcharge type – can be a fixed value or a percentage. e.g. 2.00 = $2.00 or 2.00%; 0 = $0.00 or 0%. When the card product is not subject to surcharge, the surcharge type must be set to 1 (Fixed Amount) and the surcharge value must be set to 0.
MerchantSurcharge.MinSurchargeAdjAmount / MerchantSurcharge.MinSurchargeAdjAmountInternational
Only applicable if MerchantSurcharge.SurchargeType is Percentage. Specifies the minimum surcharge amount; when the calculated applicable surcharge amount is below this value, only the Minimum Surcharge Adjustment Amount will be applied. (e.g. 2.00 = $2.00)
MerchantSurcharge.MaxSurchargeAdjAmount / MerchantSurcharge.MaxSurchargeAdjAmountInternational
Only applicable if MerchantSurcharge.SurchargeType is Percentage. Specifies the maximum surcharge amount; when the calculated applicable surcharge amount is above this value, only the Maximum Surcharge Adjustment Amount will be applied. (e.g. 2.00 = $2.00)
MerchantSurcharge.MinSurchargeableAmount / MerchantSurcharge.MinSurchargeableAmountInternational
If the surchargeable amount is below this value, surcharge is not applied and the surcharge confirmation screen shall not be presented. Note: zero-value transactions are subject to surcharge when this minimum is 0; minimum must be set to 0.01 or higher to exclude zero-value transactions.
MerchantSurcharge.MaxSurchargeableAmount / MerchantSurcharge.MaxSurchargeableAmountInternational
If the surchargeable amount is above this value, surcharge is not applied and the surcharge confirmation screen shall not be presented.
Surchargeable Amount Part of the total transaction amount which a surcharge will be applied to, as follows:
Purchase only - surchargeable amount is the purchase amount
Purchase + Cashout - surchargeable amount is the purchase amount only
Purchase + Cashout + Tip - surchargeable amount is the purchase amount only
Purchase + Tip - surchargeable amount is the purchase amount only
Cashout only - surchargeable amount is the Cashout amount
Domestic vs International
In a domestic transaction, the card country of issue matches the terminal location country
In an international transaction, the card country of issue differs from the terminal location country
MerchantSurcharge parameters with “International” suffix apply to international transactions
Last updated
Was this helpful?
