CalculateSurchargeAmountResponse
Description
This is calculated surcharge information based on the payment method, Zip Code, and amount sent in the request.
Properties
Type | Name | Description |
---|---|---|
bool | IsSurchargeEnabled | true - if surcharge is enabled on the securityId. false - if surcharge is disabled on the securityId. |
bool | IsSurchargeAllowedForZipCode | true - if surcharge is allowed for the provided Zip Code. false - if surcharge is prohibited for the provided Zip Code. |
bool | IsSurchargeAllowedForPaymentMethod | true - if surcharge is allowed for the provided payment method. false - if surcharge is prohibited for the provided payment method. |
String | SurchargePercentage | The surcharge percentage configured for the Security ID. |
String | SurchargeAmount | The calculated surcharge amount which will be charged 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 as 0. |
String | SurchargeCaption | The surcharge 'fee name' to use when displaying the fee to the user and on receipts. This denotes what the fee should actually be labeled as. |
String | SurchargeTermsNote | The message to be displayed to the user prior to charging a transaction that includes surcharging. Example: If you choose to pay with a credit card, you’ll be charged a 2.5% Surcharge. If you choose to pay with a debit card, you won’t be charged any fee. |
Updated over 1 year ago