GetSurchargeSettings

Description

The GetSurchargeSettings method retrieves the surcharge settings associated with the provided SecurityToken.

Syntax

SurchargeSettingsResponse GetSurchargeSettings(SecurityToken securityToken)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.

Return Value

Type	Description
SurchargeSettingsResponse	Returns configuration details related to surcharging. Otherwise, a fault is returned.

Example 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>********-0be8-4bf0-91cd-********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
      </ebiz:GetSurchargeSettings>
   </soapenv:Body>
</soapenv: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);

// Create the SOAP client
$client = new SoapClient("End Point URL");

// Set up the security token
$securityToken = array(
  'UserId' => '******',
  'SecurityId' => '********-****-****-****-***********',
  'Password' => '*******',
);
$response = $client->GetSurchargeSettings($securityToken);

Example 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>3</SurchargePercentage>
            <SurchargeTermsNote>If you choose to pay with a credit card, you’ll be charged a 3% 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>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:InvalidCredentials</faultcode>
         <faultstring xml:lang="en-US">Invalid Credentials</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>

Updated 6 months ago