For the complete documentation index, see llms.txt. This page is also available as Markdown.

confirm_surcharge_accessible

“Cancel” option showing “Accept” option showing

Description

Customer is prompted to confirm the surcharge amount incurred by the transaction. If no surcharge is to be applied to the transaction, the surcharge confirmation screen shall not be presented.

When Merchant.SurchargeApplicationBehavior is set to Card product-based surcharging with Merchant-override capability, the surcharge alert is displayed at the beginning of the transaction. If the merchant decides that the transaction is not subject to surcharge, no surcharge will be added and the surcharge confirmation screen shall not be presented.

When Merchant.PreauthCompletionSurchargeType is set to apply surcharge during completion, a disclaimer will be prompted indicating that this transaction may be subject to surcharge at completion during the pre-authorisation flow.

Customer Action

Selecting Accept will continue the transaction. Selecting Cancel will abort the transaction.

Per configuration, the surcharge confirmation prompt will automatically time out after a set time. In normal (non-accessible) mode, the surcharge may be automatically accepted, allowing the transaction flow to proceed, or be automatically declined, resulting in cancellation of the transaction. In accessible mode, and when configured to beep and re-prompt, the terminal will beep periodically while awaiting customer decision to proceed.

Accessibility mode gestures

Swipe left or swipe right to reveal the next available option and hear its content vocalized. Upon revealing the option, the terminal will announce “showing”. When the desired option is heard, double-tap anywhere on the screen or press the tactile accessibility button on the side of the terminal to select the shown option. Terminal will announce “selected” and move on to the next step in the transaction flow. Option cards that are swiped away will be heard again in the next “round” as the customer continues to swipe through the options; thus, erroneous swipes can be corrected easily.

Configuration ParametersMerchant.PurchaseSurchargeEnabled

Surcharge may be applied to Purchase (+ Cash + Tip) transactions if this is enabled.

&#xNAN;Merchant.ContactlessSurchargeEnabled

In addition to Merchant.PurchaseSurchargeEnabled, when this is enabled, surcharge may be applied to Contactless transactions.

&#xNAN;Merchant.CashOutOnlySurchargeEnabled

Surcharge may be applied to Cash Only transactions if this is enabled.

&#xNAN;Merchant.MotoSurchargeEnabled

Surcharge may be applied to MOTO transactions if this is enabled.

&#xNAN;Merchant.PreauthCompletionSurchargeType

Surcharge may be applied to Pre-Auth/Completion transactions as configured.

&#xNAN;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.

&#xNAN;Merchant.SurchargeConfirmationRequiredCtls

Indicates whether the surcharge amount must be confirmed by the customer after it has been calculated during Contactless transactions.”

&#xNAN;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)

&#xNAN;Merchant.DisplaySurchargeConfirmationNotice

When enabled, a textual notice message will be displayed on the customer surcharge confirmation prompt.

&#xNAN;Terminal.SurchargeConfirmationTimeout

The time in seconds that the surcharge confirmation screen will be displayed, before it is automatically dismissed.

&#xNAN;MerchantSurcharge.MerchantId

Identifies the merchant to which the surcharge settings apply to.

&#xNAN;MerchantSurcharge.ProductId

Identifies the card product to which the surcharge settings apply to.

&#xNAN;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.

&#xNAN;MerchantSurcharge.SurchargeType / MerchantSurcharge.SurchargeTypeInternational

Specifies the type of surcharge to apply; one of: Not Configured : 0, Fixed Amount : 1, Percentage : 2.

&#xNAN;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.

&#xNAN;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)

&#xNAN;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)

&#xNAN;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.

&#xNAN;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

Surchargeable Amount

Domestic vs International

Error Scenarios

If the customer cancels the transaction, Operator Abort message will be shown.

If the device crashes or device reboots while on this screen, when the payment application restarts or device boots up, no power failure recovery will happen.

If the transaction times out, Transaction Timeout message will be shown when configured to automatically cancel on timeout.

---

Last updated

Was this helpful?