CalculateSurchargeAmountResponse

Description

The CalculateSurchargeAmountResponse object returns calculated surcharge information based on the payment method, ZIP code, and amount sent in the CalculateSurchargeAmount request.

Properties

Type	Name	Description
boolean	IsSurchargeEnabled	Whether surcharge is enabled for the `securityId`. Possible Values `true`- Surcharge is enabled for the securityId. `false` - Surcharge is disabled for the securityId.
boolean	IsSurchargeAllowedForZipCode	Whether surcharging is allowed for the zip code. Possible Values `true`- Surcharging is allowed for the provided zip code. `false` - Surcharging is prohibited for the provided zip code.
boolean	IsSurchargeAllowedForPaymentMethod	Whether surcharge is allowed for the provided payment method. Possible Values `true`- Surcharging is allowed for the provided payment method. `false` - Surcharging is prohibited for the provided payment method.
string	SurchargePercentage	Surcharge percentage configured for the `securityId`.
string	SurchargeAmount	Calculates the surcharge amount added on top of the amount submitted in the request. Note: If surcharge is enabled but the location or payment method prohibits surcharging, this will return 0.
string	SurchargeCaption	The surcharge "fee name" used when showing the fee to the user and on receipts.
string	SurchargeTermsNote	Message displayed to the user before charging a transaction that includes a surcharge. Example: "If you choose to pay with a credit card, you’ll be charged a 2.5% Surcharge. "