Syntch Gateway API

GetVirtualTerminalSettings

Merchant Virtual Terminal Configuration Settings (BETA)

**Requires Authentication**
Required role:	Merchant

The following routes are available for this service:
GET	/merchants/{merchantKey}/vt-configurations	BETA VERSION (Subject to change). Gets virtual terminal configuration settings for the merchant key provided.

**GetVirtualTerminalSettings** Parameters:
Name	Parameter	Data Type	Required	Description
MerchantKey	path	integer	Yes	The key of the merchant.
IncludeAllCustomers	query	bool	No	Include all non-deleted customers or those in active state only.

**VirtualTerminalSettings** Parameters:
Name	Parameter	Data Type	Required
DisplaySettings	form	DisplaySettings	No
Customers	form	List<Customer>	No
Registers	form	List<Register>	No
CustomFields	form	List<CustomField>	No

**DisplaySettings** Parameters:
Name	Parameter	Data Type	Required
DisplayShippingAmount	form	bool	No
DisplayConvenienceAmount	form	bool	No
DisplayConvenienceAmountPercentage	form	bool	No
DisplayDutyAmount	form	bool	No
DisplayTipAmount	form	bool	No
DisplayInvoiceNumber	form	bool	No
DisplayPurchaseOrderNumber	form	bool	No
DisplayCustomerNumber	form	bool	No
DisplayCustomerSelect	form	bool	No
DisplayPurchaseLineItems	form	bool	No
DisplayTaxAmount	form	bool	No
DisplayForceDuplicate	form	bool	No
DisplayBillingZipCode	form	bool	No
DisplayBillingCityStreetState	form	bool	No
DisplayBillingPhone	form	bool	No
DisplayBillingEmail	form	bool	No
RequireShippingAmount	form	bool	No
RequireInvoiceNumber	form	bool	No
RequireNameOnCard	form	bool	No
RequireBillingZipCode	form	bool	No
RequireTaxAmount	form	bool	No
RequirePurchaseOrderNumber	form	bool	No
AllowRefunds	form	bool	No
AllowForceCapture	form	bool	No
AutoCalculateTax	form	bool	No
AutoTaxAmount	form	float	No
EnableBinCheck	form	bool	No

**Customer** Parameters:
Name	Parameter	Data Type	Required
CustomerKey	form	int	No
CustomerId	form	string	No
CustomerName	form	string	No
HasCardTokens	form	bool	No
HasCheckTokens	form	bool	No

**Register** Parameters:
Name	Parameter	Data Type	Required	Description
RegisterKey	form	int	No
RegisterName	form	string	No

**CustomField** Parameters:
Name	Parameter	Data Type	Required	Description
Key	model	int?	No	Gateway key for the custom field
Name	model	string	No	Name of the custom field as set by the merchant
Value	model	string	No	Value (if applicable) to store in the custom field

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /merchants/{merchantKey}/vt-configurations HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VirtualTerminalSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Merchants.BindingModels.VirtualTerminal">
  <CustomFields>
    <CustomField>
      <DecimalPlaces>0</DecimalPlaces>
      <Description>String</Description>
      <ErrorMessage>String</ErrorMessage>
      <IsNumeric>false</IsNumeric>
      <IsRequired>false</IsRequired>
      <Key>0</Key>
      <MaxLength>0</MaxLength>
      <MaxValue>0</MaxValue>
      <MerchantKey>0</MerchantKey>
      <MinValue>0</MinValue>
      <Name>String</Name>
      <Position>0</Position>
      <RegularExpression>String</RegularExpression>
    </CustomField>
  </CustomFields>
  <Customers>
    <Customer>
      <CustomerId>String</CustomerId>
      <CustomerKey>0</CustomerKey>
      <CustomerName>String</CustomerName>
      <HasCardTokens>false</HasCardTokens>
      <HasCheckTokens>false</HasCheckTokens>
    </Customer>
  </Customers>
  <DisplaySettings>
    <AllowForceCapture>false</AllowForceCapture>
    <AllowRefunds>false</AllowRefunds>
    <AutoCalculateTax>false</AutoCalculateTax>
    <AutoTaxAmount>0</AutoTaxAmount>
    <DisplayBillingCityStreetState>false</DisplayBillingCityStreetState>
    <DisplayBillingEmail>false</DisplayBillingEmail>
    <DisplayBillingPhone>false</DisplayBillingPhone>
    <DisplayBillingZipCode>false</DisplayBillingZipCode>
    <DisplayConvenienceAmount>false</DisplayConvenienceAmount>
    <DisplayConvenienceAmountPercentage>false</DisplayConvenienceAmountPercentage>
    <DisplayCustomerNumber>false</DisplayCustomerNumber>
    <DisplayCustomerSelect>false</DisplayCustomerSelect>
    <DisplayDutyAmount>false</DisplayDutyAmount>
    <DisplayForceDuplicate>false</DisplayForceDuplicate>
    <DisplayInvoiceNumber>false</DisplayInvoiceNumber>
    <DisplayPurchaseLineItems>false</DisplayPurchaseLineItems>
    <DisplayPurchaseOrderNumber>false</DisplayPurchaseOrderNumber>
    <DisplayShippingAmount>false</DisplayShippingAmount>
    <DisplayTaxAmount>false</DisplayTaxAmount>
    <DisplayTipAmount>false</DisplayTipAmount>
    <EnableBinCheck>false</EnableBinCheck>
    <RequireBillingZipCode>false</RequireBillingZipCode>
    <RequireInvoiceNumber>false</RequireInvoiceNumber>
    <RequireNameOnCard>false</RequireNameOnCard>
    <RequirePurchaseOrderNumber>false</RequirePurchaseOrderNumber>
    <RequireShippingAmount>false</RequireShippingAmount>
    <RequireTaxAmount>false</RequireTaxAmount>
  </DisplaySettings>
  <Registers>
    <Register>
      <RegisterKey>0</RegisterKey>
      <RegisterName>String</RegisterName>
    </Register>
  </Registers>
</VirtualTerminalSettings>