GetMerchantIntegrationSettings

Description

The GetMerchantIntegrationSettings method retrieves the merchant settings associated with the merchant account linked to a SecurityId.

Syntax

MerchantIntegrationSettings[] GetMerchantIntegrationSettings(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

Field	Description
MerchantIntegrationSettings[]	Returns a list of integration settings for the merchant.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:GetMerchantIntegrationSettings>
         <ebiz:securityToken>
            <ebiz:SecurityId>*************634621-b899***************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
      </ebiz:GetMerchantIntegrationSettings>
   </soapenv:Body>
</soapenv:Envelope>

IeBizServiceClient client = new IeBizServiceClient();

// The EBizCharge API security token
SecurityToken securityToken = new SecurityToken
{
    SecurityId = "********-****-****-****-************",
    UserId = "************",
    Password = "************"
};

// Get the merchant integration settings from the API
MerchantIntegrationSettings[] merchantIntegrationSettingsResponse = client.GetMerchantIntegrationSettings(securityToken);

$client = new SoapClient('End Point URL');
$securityToken = array(
        'SecurityId' => '********421b-86ce********',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
); 
$params = array(
     'securityToken' => $securityToken
 );
$response = $client->GetMerchantIntegrationSettings($params);

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">
      <GetMerchantIntegrationSettingsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetMerchantIntegrationSettingsResult>
            <MerchantIntegrationSettings>
               <SettingName>EnableAVSWarnings</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>EnableCVVWarnings</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>UseFullAmountForAVS</SettingName>
               <SettingValue>True</SettingValue>
               <SettingDescription>Verify card by running a preauth with the full transaction amount to retrieve Avs and Cvv responses</SettingDescription>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>DeclineTransactionIfAVSWarningsAreDisabled</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>VerifyCreditCardBeforeSaving</SettingName>
               <SettingValue>False</SettingValue>
               <SettingDescription>Verify card before saving using $0.05 preauth</SettingDescription>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>AllowACHPayments</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>AllowCreditCardPayments</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>IsSurchargeEnabled</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>SurchargePercentage</SettingName>
               <SettingValue>0</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>SurchargeCaption</SettingName>
               <SettingValue/>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>SurchargeTypeId</SettingName>
               <SettingValue/>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>SurchargeCountryId</SettingName>
               <SettingValue/>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>SurchargeTermsNote</SettingName>
               <SettingValue/>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>BatchProcessingSurchargeTermsNote</SettingName>
               <SettingValue/>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>MerchantCanEnableOrDisableSurchargePerTransaction</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>IsEMVEnabled</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>IsEMVPreAuthEnabled</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>UseEConnectTransactionReceipts</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>UseEconnectPaymentMethods</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>EnableLendicaOnCloudVT</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>EnableLendicaOnAdminPortal</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>EnableLendicaOnCustomerPortal</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>EnablePaymentTerms</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>ShowSaveCardOptionInEmailForm</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>ShowSetAsDefaultCardOptionInEmailForm</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>AllowQuickPayment</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>AllowViewInvoice</SettingName>
               <SettingValue>True</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>AllowViewCredit</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>MerchantTimeZoneId</SettingName>
               <SettingValue>Pacific Standard Time</SettingValue>
            </MerchantIntegrationSettings>
            <MerchantIntegrationSettings>
               <SettingName>IsInvoicePdfHostedByEBizCharge</SettingName>
               <SettingValue>False</SettingValue>
            </MerchantIntegrationSettings>
         </GetMerchantIntegrationSettingsResult>
      </GetMerchantIntegrationSettingsResponse>
   </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>