Guides

GetSurchargeSettings

Description

This API will return the surcharge settings for the security token used to make the API call. When this API is called it will return information such as whether Surcharge is enabled for the securityId, the surcharge percentage, etc.

Syntax

GetSurchargeSettings (SecurityToken securityToken)

Arguments

TypeNameDescription
SecurityToken securityTokenMerchant security token: used to identify merchant and validate transaction. (required)

Return Value

TypeDescription
SurchargeSettingsResponseReturns results of the search surcharge settings request.

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:GetSurchargeSettings>
         <ebiz:securityToken>
            <ebiz:SecurityId>5a38a553-0be8-4bf0-91cd-********</ebiz:SecurityId>
            <ebiz:UserId>******testing</ebiz:UserId>
            <ebiz:Password>p05******QmW79F</ebiz:Password>
         </ebiz:securityToken>
      </ebiz:GetSurchargeSettings>
   </soapenv:Body>
</soapenv:Envelope>


Response:
                  
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetSurchargeSettingsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetSurchargeSettingsResult>
            <IsSurchargeEnabled>true</IsSurchargeEnabled>
            <SurchargeCountryId>USA</SurchargeCountryId>
            <SurchargePercentage>2.5</SurchargePercentage>
            <SurchargeTermsNote>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.</SurchargeTermsNote>
            <SurchargeCaption>Surcharge</SurchargeCaption>
           <SurchargeTypeId>DailyDiscount</SurchargeTypeId>
         </GetSurchargeSettingsResult>
      </GetSurchargeSettingsResponse>
   </s:Body>
</s:Envelope>

SecurityToken securityToken = new SecurityToken();
securityToken.SecurityId = "********-****-****-****-************";
securityToken.UserId = "********";
securityToken.Password = "********";

IeBizServiceClient client = new IeBizServiceClient();

SurchargeSettingsResponse surchargeSettingsResponse = client.GetSurchargeSettings(securityToken);

Console.WriteLine("Surcharge Enabled:    " + surchargeSettingsResponse.IsSurchargeEnabled);
Console.WriteLine("Surcharge Country ID: " + surchargeSettingsResponse.SurchargeCountryId);
Console.WriteLine("Surcharge Percentage: " + surchargeSettingsResponse.SurchargePercentage);
Console.WriteLine("Surcharge TermsNote:  " + surchargeSettingsResponse.SurchargeTermsNote);
Console.WriteLine("Surcharge Caption:    " + surchargeSettingsResponse.SurchargeCaption);

Updated 9 months ago