Syntch Gateway API

GetMerchants

Administration - Merchant Management

**Requires Authentication**
Required role:	Reseller

The following routes are available for this service:
GET	/merchants	Get a list of merchants for the reseller request.

**GetMerchants** Parameters:
Name	Parameter	Data Type	Required	Description
MerchantName	query	string	No	Filters to a 'contains' match on the merchant name.
ResellerName	query	string	No	Filters to a 'contains' match on the reseller name.
MerchantId	query	string	No	Filters to an exact match of the merchant id.
PhoneNumber	query	string	No	Filters to a merchant by phone number
SortField	query	string	No	The field name by which the records will be sorted. Default is 'Merchant Name'. Allowable Values MerchantName MerchantId ActivationStatus CreationTimestamp MerchantKey
IncludeDeleted	query	bool	No	Whether to include deleted records in the response, defaults to false.

**SortedRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
SortDirection	query	string	No	The direction in which the records will be sorted. Default is 'asc'. Allowable Values Asc Desc
SortField	query	string	No	The field name by which the records will be sorted.

**PaginatedRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
PageSize	query	short	No	The number of records per page. Default is 20.
PageNumber	query	short	No	The page number to fetch. Default is 1.

**MerchantDetailResults** Parameters:
Name	Parameter	Data Type	Required	Description
Merchants	model	List<MerchantDetail>	No	A collection of merchants.
Pagination	model	PaginationStats	No	Pagination stats regarding the result set.

**MerchantDetail** Parameters:
Name	Parameter	Data Type	Required	Description
MerchantKey	model	int	No	Unique (system-generated) identifier.
ResellerKey	model	int	No	Parent reseller containing the merchant.
DefaultUserKey	model	int?	No	The default user for the merchant.
PrimaryContactKey	model	int?	No	The primary contact for the merchant.
MerchantName	model	string	No	The name of the merchant.
MerchantId	model	string	No	Identifier (user-supplied) for the merchant.
AlternateMerchantId	model	string	No	Alternate identifier (user-supplied) for the merchant.
AutoCloseBatch	model	bool	No	Enable/disable auto-closing of the merchant's batch (for terminal capture processor configurations).
AutoCloseBatchHour	model	DateTime	No	Hour for auto-close to occur, if enabled.
ForceDuplicate	model	bool	No	If enabled, the gateway will block transactions that appear to duplicate an existing transaction within the same day, and will require a ForceDuplicate flag to override.
RequirePNRef	model	bool?	No	If enabled, the merchant must supply a valid PNRef of an original sale to process a refund, and the refund may not be greater than the amount of the original sale. Disabling this option allows 'unlinked returns'.
IsTestMerchant	model	bool	No	When enabled, transactions are directed to the processors' test hosts for development and testing purposes.
ActivationStatus	model	ActivationStatus	No	The activation status of the merchant. Allowable Values Pending Active Inactive Deleted
EnableFraud	model	bool?	No	Indicated if fraud detection is on or off.
EnableOfflineBatch	model	bool?	No	Indicates if offline batched are on or off.
AllowHostedPage	model	bool?	No	Indicates is the merchant should have access to the hosted payments page.
AllowEmulator	model	bool?	No	Indicates if use of the emulator is allowed.
LimitToDebit	model	bool?	No
CollectLevel3	model	bool?	No
CreationTimestamp	model	DateTime	No	The timestamp of the merchant record's creation.
MerchantConfigurations	model	MerchantConfigurations	No	A collection of merchant configuration data.
ResellerParents	model	List<ResellerTreeParent>	No	Parent reseller (or resellers) of this merchant, and the relationship among them if there are multiple
SelfLink	model	string	No	A self reference to the merchant.
ResellerLink	model	string	No	A reference to the reseller of the merchant.
DefaultUserLink	model	string	No	A reference to the default user of the merchant.
PrimaryContactLink	model	string	No	A reference to the primary contact of the merchant.
ProcessorProfilesLink	model	string	No	A reference to the processor profiles of the merchant.
BusinessInformationLink	model	string	No	A reference to the business information of the merchant.
AddressInformationLink	model	string	No	A reference to the address information of the merchant.

**ActivationStatus** Enum:
Pending
Active
Inactive
Deleted

**MerchantConfigurations** Parameters:
Name	Parameter	Data Type	Required	Description
SecuritySettings	model	MerchantSecuritySettings	No	A collection of security settings for the merchant.
AccessSettings	model	MerchantAccessSettings	No	A collection of access settings for the merchant.
MerchantVirtualTerminalSettings	model	MerchantVirtualTerminalSettings	No	A collection of virtual terminal settings for the merchant.

**MerchantSecuritySettings** Parameters:
Name	Parameter	Data Type	Required
SaleLevel	form	string	No
CreditLevel	form	string	No
VoidLevel	form	string	No
PreAuthLevel	form	string	No
ForceAuthLevel	form	string	No
AdjustLevel	form	string	No
ActivateLevel	form	string	No
DeactivateLevel	form	string	No
InquireLevel	form	string	No
RedeemLevel	form	string	No
ReloadLevel	form	string	No
RefundLevel	form	string	No
ToolsLevel	form	string	No
ReportsLevel	form	string	No
CurrentBatchLevel	form	string	No
BatchesLevel	form	string	No
AdminLevel	form	string	No
ChangeSecurityLevel	form	string	No
SettleLevel	form	string	No
RecurringBillingLevel	form	string	No
PreferenceLevel	form	string	No
FraudLevel	form	string	No

**MerchantAccessSettings** Parameters:
Name	Parameter	Data Type	Required
BinManagementApi	form	bool	No
DialIn	form	bool	No
Internet	form	bool	No

**MerchantVirtualTerminalSettings** Parameters:
Name	Parameter	Data Type	Required
AllowForceCapture	form	bool	No
VirtualTerminalCreditAccess	form	bool	No
VirtualTerminalLevel3Amount	form	bool	No
VirtualTerminalConvenienceAmount	form	bool	No
VirtualTerminalConvenienceAmountPercentage	form	bool	No
VirtualTerminalConvenienceLabel	form	string	No
virtualTerminalConvenienceAmountPercentageDefault	form	double	No
VirtualTerminalDutyAmount	form	bool	No
VirtualTerminalTaxAmount	form	bool	No
VirtualTerminalTipAmount	form	bool	No
ImageCapture	form	bool	No
ReceiptCapture	form	bool	No
AutoSettleMerchantEmail	form	bool	No
InvoiceDuplicate	form	bool	No
VirtualTerminalCommercialCard	form	bool	No
VirtualTerminalShippingAmount	form	bool	No
VirtualTerminalAllowRepeat	form	bool	No
RequireInvoice	form	bool	No
RequireNameOnCard	form	bool	No
RequireLevelII	form	bool	No
VirtualTerminalRecurringBilling	form	bool	No
VirtualTerminalEmailReceipts	form	bool	No
VirtualTerminalPrintTwoReceipts	form	bool	No
VirtualTerminalInvNum	form	bool	No
VirtualTerminalPONum	form	bool	No
VirtualTerminalCustomerID	form	bool	No
VirtualTerminalCustomer	form	bool	No
VirtualTerminalStreet	form	bool	No
VirtualTerminalCity	form	bool	No
VirtualTerminalState	form	bool	No
VirtualTerminalZip	form	bool	No
VirtualTerminalPhone	form	bool	No
VirtualTerminalEmail	form	bool	No
VirtualTerminalAutoTaxAmount	form	float	No
VirtualTerminalAutoCalcTax	form	bool	No
EnableFraud	form	bool	No
EnableOfflineBatch	form	bool	No
EnableHostedPage	form	bool	No
EnableEmulator	form	bool	No
LimitToDebit	form	bool	No
CollectLevel3	form	bool	No
AuthEdit	form	bool	No
IsMerchantBillingAccount	form	bool	No
ApplyLevel2DefaultsToApi	form	bool	No
RequireShipping	form	bool	No
RequireZipCode	form	bool	No
EnableGsaBinCheck	form	bool	No
ResellerOnlyCustomFieldsMenu	form	bool	No
ResellerOnlyHostedPaymentPageMenu	form	bool	No
ResellerOnlyOrderDataDefaultsMenu	form	bool	No
ResellerOnlyEmulatorMenu	form	bool	No
ResellerOnlyFraudControlSettingsMenu	form	bool	No
ResellerOnlyFraudControlHeldLogMenus	form	bool	No
CardVerification	form	MerchantCardVerificationSettings	No

**MerchantCardVerificationSettings** Parameters:
Name	Parameter	Data Type	Required
AVAddNotVerifiable	form	bool	No
AVInvalidAddZip	form	bool	No
AVZipOnly	form	bool	No
AVNoMatch	form	bool	No
AVIssuerUnavail	form	bool	No
AVVerUnavail	form	bool	No
AVAddOnly	form	bool	No
AVNotRequested	form	bool	No
AVUnregCode	form	bool	No
AVServUnsupported	form	bool	No
AVExactMatch	form	bool	No
AVNoData	form	bool	No
AVAddNotVerifiableGlobal	form	bool	No
CVNotPresent	form	bool	No
CVNoData	form	bool	No
CVNotProcessed	form	bool	No
CVNoDataFromIssuer	form	bool	No
CVMatch	form	bool	No
CVUnregCode	form	bool	No
CVNoMatch	form	bool	No

**ResellerTreeParent** Parameters:
Name	Parameter	Data Type	Required
ResellerKey	form	int	No
ResellerName	form	string	No
Level	form	int	No
Parent	form	int?	No
Child	form	int?	No

**PaginationStats** Parameters:
Name	Parameter	Data Type	Required
CurrentPageNumber	form	int	No
PageSize	form	int	No
TotalRecordCount	form	int	No

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

HTTP + JSV

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

GET /merchants HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Merchants: 
	[
		{
			MerchantKey: 0,
			ResellerKey: 0,
			DefaultUserKey: 0,
			PrimaryContactKey: 0,
			MerchantName: String,
			MerchantId: String,
			AlternateMerchantId: String,
			AutoCloseBatch: False,
			AutoCloseBatchHour: 0001-01-01,
			ForceDuplicate: False,
			RequirePNRef: False,
			IsTestMerchant: False,
			ActivationStatus: Pending,
			EnableFraud: False,
			EnableOfflineBatch: False,
			AllowHostedPage: False,
			AllowEmulator: False,
			LimitToDebit: False,
			CollectLevel3: False,
			CreationTimestamp: 0001-01-01,
			MerchantConfigurations: 
			{
				SecuritySettings: 
				{
					SaleLevel: String,
					CreditLevel: String,
					VoidLevel: String,
					PreAuthLevel: String,
					ForceAuthLevel: String,
					AdjustLevel: String,
					ActivateLevel: String,
					DeactivateLevel: String,
					InquireLevel: String,
					RedeemLevel: String,
					ReloadLevel: String,
					RefundLevel: String,
					ToolsLevel: String,
					ReportsLevel: String,
					CurrentBatchLevel: String,
					BatchesLevel: String,
					AdminLevel: String,
					ChangeSecurityLevel: String,
					SettleLevel: String,
					RecurringBillingLevel: String,
					PreferenceLevel: String,
					FraudLevel: String
				},
				AccessSettings: 
				{
					BinManagementApi: False,
					DialIn: False,
					Internet: False
				},
				MerchantVirtualTerminalSettings: 
				{
					AllowForceCapture: False,
					VirtualTerminalCreditAccess: False,
					VirtualTerminalLevel3Amount: False,
					VirtualTerminalConvenienceAmount: False,
					VirtualTerminalConvenienceAmountPercentage: False,
					VirtualTerminalConvenienceLabel: String,
					virtualTerminalConvenienceAmountPercentageDefault: 0,
					VirtualTerminalDutyAmount: False,
					VirtualTerminalTaxAmount: False,
					VirtualTerminalTipAmount: False,
					ImageCapture: False,
					ReceiptCapture: False,
					AutoSettleMerchantEmail: False,
					InvoiceDuplicate: False,
					VirtualTerminalCommercialCard: False,
					VirtualTerminalShippingAmount: False,
					VirtualTerminalAllowRepeat: False,
					RequireInvoice: False,
					RequireNameOnCard: False,
					RequireLevelII: False,
					VirtualTerminalRecurringBilling: False,
					VirtualTerminalEmailReceipts: False,
					VirtualTerminalPrintTwoReceipts: False,
					VirtualTerminalInvNum: False,
					VirtualTerminalPONum: False,
					VirtualTerminalCustomerID: False,
					VirtualTerminalCustomer: False,
					VirtualTerminalStreet: False,
					VirtualTerminalCity: False,
					VirtualTerminalState: False,
					VirtualTerminalZip: False,
					VirtualTerminalPhone: False,
					VirtualTerminalEmail: False,
					VirtualTerminalAutoTaxAmount: 0,
					VirtualTerminalAutoCalcTax: False,
					EnableFraud: False,
					EnableOfflineBatch: False,
					EnableHostedPage: False,
					EnableEmulator: False,
					LimitToDebit: False,
					CollectLevel3: False,
					AuthEdit: False,
					IsMerchantBillingAccount: False,
					ApplyLevel2DefaultsToApi: False,
					RequireShipping: False,
					RequireZipCode: False,
					EnableGsaBinCheck: False,
					ResellerOnlyCustomFieldsMenu: False,
					ResellerOnlyHostedPaymentPageMenu: False,
					ResellerOnlyOrderDataDefaultsMenu: False,
					ResellerOnlyEmulatorMenu: False,
					ResellerOnlyFraudControlSettingsMenu: False,
					ResellerOnlyFraudControlHeldLogMenus: False,
					CardVerification: 
					{
						AVAddNotVerifiable: False,
						AVInvalidAddZip: False,
						AVZipOnly: False,
						AVNoMatch: False,
						AVIssuerUnavail: False,
						AVVerUnavail: False,
						AVAddOnly: False,
						AVNotRequested: False,
						AVUnregCode: False,
						AVServUnsupported: False,
						AVExactMatch: False,
						AVNoData: False,
						AVAddNotVerifiableGlobal: False,
						CVNotPresent: False,
						CVNoData: False,
						CVNotProcessed: False,
						CVNoDataFromIssuer: False,
						CVMatch: False,
						CVUnregCode: False,
						CVNoMatch: False
					}
				}
			},
			ResellerParents: 
			[
				{
					ResellerKey: 0,
					ResellerName: String,
					Level: 0,
					Parent: 0,
					Child: 0
				}
			],
			SelfLink: /merchants/0,
			ResellerLink: /resellers/0,
			DefaultUserLink: /users/0,
			PrimaryContactLink: /contacts/0,
			ProcessorProfilesLink: /merchants/0/processor-profiles,
			BusinessInformationLink: /merchants/0/business-informations,
			AddressInformationLink: /merchants/0/addresses
		}
	],
	Pagination: 
	{
		CurrentPageNumber: 0,
		PageSize: 0,
		TotalRecordCount: 0
	}
}

Syntch Gateway API

GetMerchants

Allowable Values

Allowable Values

Allowable Values

HTTP + JSV