Syntch Gateway API

PostMerchant

Administration - Merchant Management

**Requires Authentication**
Required role:	Reseller

The following routes are available for this service:
POST	/merchants	Creates a new merchant.

**PostMerchant** Parameters:
Name	Parameter	Data Type	Required	Description
ResellerKey	model	int?	No	The reseller key, if supplied must the in the reseller's hierarchy.
MerchantName	model	string	No	The merchant name.
MerchantId	model	string	No	The merchant ID.
AlternateMerchantId	model	string	No	The alternate merchant ID.
AutoCloseBatch	model	bool	No	Whether to auto-close batches, default is true.
AutoCloseBatchTimestamp	model	DateTime	No	When to auto-close batches, default is 10:00 PM.
ForceDuplicate	model	bool	No	Whether to force duplicates, default is true.
RequirePNRef	model	bool?	No	Whether to require PnRef.
IsTestMerchant	model	bool	No	Whether this is a test merchant, default is false.
DefaultUserIsApiUser	model	bool	No	If a default user is to be created, determines if it should be an API user. Default is false.
ActivationStatus	model	string	Yes	The activation status. Allowable Values Pending Active
PrimaryContact	model	Contact	No	The primary contact for the merchant.
BusinessInformation	model	BusinessInformation	No	The business information for the merchant.
DefaultUser	model	GatewayUser	No	The default user for the merchant.
AccessSettings	model	MerchantAccessSettings	No	Access settings for the merchant.
VirtualTerminalSettings	model	MerchantVirtualTerminalSettings	No	Virtual terminal settings for the merchant.
FraudSettings	model	MerchantFraudSettings	No	Fraud settings for the merchant.
BillingSettings	model	MerchantBillingSettings	No	Merchant Billing settings for the merchant.

**Contact** Parameters:
Name	Parameter	Data Type	Required	Description
LastName	model	string	No	The last name, max 50 chars
FirstName	model	string	No	The first name, max 50 chars
JobTitle	model	string	No	The job title, max 50 chars
DepartmentName	model	string	No	The department name, max 50 chars
EmailAddress	model	string	No	The e-mail address, max 100 chars
DaytimeTelephoneNumber	model	string	No	The daytime telephone number, max 25 chars
NighttimeTelephoneNumber	model	string	No	The nighttime telephone number, max 25 chars
FaxNumber	model	string	No	The fax number, max 25 chars
MobileTelephoneNumber	model	string	No	The mobile telephone number, max 25 chars
BillingAddress	model	Address	No	Billing address for the primary contact.
ShippingAddress	model	Address	No	Shipping address for the primary contact

**Address** Parameters:
Name	Parameter	Data Type	Required	Description
StreetAddress1	model	string	Yes	The street address, max 50 chars
StreetAddress2	model	string	No	The street address 2, max 50 chars
StreetAddress3	model	string	No	The street address 3, max 50 chars
City	model	string	No	The city, max 50 chars
StateOrProvinceCode	model	string	Yes	The CHAR-2 USA state and CAN province codes Allowable Values AK AL AR AZ CA CO CT DC DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY OH OK OR PA RI SC SD TN TX UT VA VT WA WI WV WY AB BC MB NB NL NS NT NU ON PE QC SK YT
PostalCode	model	string	Yes	The postal code, max 30 chars
CountryCode	model	string	Yes	The ISO Alpha-3 USA or CAN country codes Allowable Values USA CAN

**BusinessInformation** Parameters:
Name	Parameter	Data Type	Required	Description
DbaName	model	string	No	The doing business as name, max 50 chars
TelephoneNumber	model	string	No	The telephone number, max 13 chars
Address	model	Address	Yes	The primary contact info.

**GatewayUser** Parameters:
Name	Parameter	Data Type	Required
UserName	form	string	No
PhoneNumber	form	string	No
Id	form	int	No
DeleterUserId	form	long?	No
CreatorUserId	form	long	No
LastModifierUserId	form	long?	No
IsLockoutEnabled	form	bool	No
Roles	form	ICollection<GatewayUserRole<Int64>>	No
Claims	form	ICollection<UserClaim>	No
Logins	form	ICollection<GatewayUserLogin<Int64>>	No
IsPhoneNumberConfirmed	form	bool	No
SecurityStamp	form	string	No
IsTwoFactorEnabled	form	bool	No
IsDeleted	form	bool	No
IsEmailConfirmed	form	bool	No
AccessFailedCount	form	int	No
LockoutEndDateUtc	form	DateTime?	No
CreationTime	form	DateTime	No
LastModificationTime	form	DateTime?	No
DeletionTime	form	DateTime?	No
FirstName	form	string	No
EmailConfirmationCode	form	string	No
Password	form	string	No
LastName	form	string	No
IsActive	form	bool	No
EmailAddress	form	string	No
TenantId	form	int?	No
AuthenticationSource	form	string	No
PasswordResetCode	form	string	No
LastLoginTime	form	DateTime?	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Country	form	string	No
Timezone	form	string	No
ShouldChangePasswordOnNextLogin	form	bool	No

**UserClaim** Parameters:
Name	Parameter	Data Type	Required
ClaimType	form	string	No
ClaimValue	form	string	No
CreatorId	form	int	No
TenantId	form	int	No
CreateTime	form	DateTime	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

**MerchantFraudSettings** Parameters:
Name	Parameter	Data Type	Required
DailyVelocitySettings	form	DailyVelocityFraudSettings	No
IpFilteringSettings	form	IpFilteringFraudSettings	No
AmountSettings	form	AmountFraudSettings	No
HourlyVelocitySettings	form	HourlyVelocityFraudSettings	No
TransactionIpVelocitySettings	form	TransactionIpVelocityFraudSettings	No

**DailyVelocityFraudSettings** Parameters:
Name	Parameter	Data Type	Required
Enabled	form	bool	No
TransactionCount	form	int	No
Action	form	FraudAction	No
EmailEnabled	form	bool	No
EmailAddresses	form	string	No

**FraudAction** Enum:
Audit
AuditAndHold
Decline

**IpFilteringFraudSettings** Parameters:
Name	Parameter	Data Type	Required
Enabled	form	bool	No
AllowedCountries	form	AllowedCountries	No
BlockedIpAddresses	form	string	No
Action	form	FraudAction	No
EmailEnabled	form	bool	No
EmailAddresses	form	string	No

**AllowedCountries** Enum:
US
CA

**AmountFraudSettings** Parameters:
Name	Parameter	Data Type	Required
Enabled	form	bool	No
LowerLimit	form	decimal	No
UpperLimit	form	decimal	No
Action	form	FraudAction	No
EmailEnabled	form	bool	No
EmailAddresses	form	string	No

**HourlyVelocityFraudSettings** Parameters:
Name	Parameter	Data Type	Required
Enabled	form	bool	No
TransactionCount	form	int	No
Action	form	FraudAction	No
EmailEnabled	form	bool	No
EmailAddresses	form	string	No

**TransactionIpVelocityFraudSettings** Parameters:
Name	Parameter	Data Type	Required
Enabled	form	bool	No
TransactionCountPerHour	form	int	No
ExcludedIpAddresses	form	string	No
Action	form	FraudAction	No
EmailEnabled	form	bool	No
EmailAddresses	form	string	No

**MerchantBillingSettings** Parameters:
Name	Parameter	Data Type	Required	Description
ContractKey	form	int	No
PricePlanKey	form	int	No

**HttpResult** Parameters:
Name	Parameter	Data Type	Required
ResponseText	form	string	No
FileInfo	form	FileInfo	No
ContentType	form	string	No
Headers	form	Dictionary<string, string>	No
Cookies	form	List<Cookie>	No
ETag	form	string	No
Age	form	TimeSpan?	No
MaxAge	form	TimeSpan?	No
Expires	form	DateTime?	No
LastModified	form	DateTime?	No
CacheControl	form	CacheControl	No
ResultScope	form	Func<IDisposable>	No
AllowsPartialResponse	form	bool	No
Options	form	IDictionary<string, string>	No
Status	form	int	No
StatusCode	form	HttpStatusCode	No
StatusDescription	form	string	No
Response	form	Object	No
ResponseFilter	form	IContentTypeWriter	No
RequestContext	form	IRequest	No
View	form	string	No
Template	form	string	No
PaddingLength	form	int	No
IsPartialRequest	form	bool	No

**CacheControl** Enum:
Name	Value
None	0
Public	1
Private	2
MustRevalidate	4
NoCache	8
NoStore	16
NoTransform	32
ProxyRevalidate	64

**IRequest** Parameters:
Name	Parameter	Data Type	Required
OriginalRequest	form	Object	No
Response	form	IResponse	No
OperationName	form	string	No
Verb	form	string	No
RequestAttributes	form	RequestAttributes	No
RequestPreferences	form	IRequestPreferences	No
Dto	form	Object	No
ContentType	form	string	No
IsLocal	form	bool	No
UserAgent	form	string	No
Cookies	form	IDictionary<string, Cookie>	No
ResponseContentType	form	string	No
HasExplicitResponseContentType	form	bool	No
Items	form	Dictionary<string, Object>	No
Headers	form	NameValueCollection	No
QueryString	form	NameValueCollection	No
FormData	form	NameValueCollection	No
UseBufferedStream	form	bool	No
RawUrl	form	string	No
AbsoluteUri	form	string	No
UserHostAddress	form	string	No
RemoteIp	form	string	No
Authorization	form	string	No
IsSecureConnection	form	bool	No
AcceptTypes	form	string[]	No
PathInfo	form	string	No
OriginalPathInfo	form	string	No
ContentLength	form	long	No
Files	form	IHttpFile[]	No
UrlReferrer	form	Uri	No

**IResponse** Parameters:
Name	Parameter	Data Type	Required
OriginalResponse	form	Object	No
Request	form	IRequest	No
StatusCode	form	int	No
StatusDescription	form	string	No
ContentType	form	string	No
Dto	form	Object	No
UseBufferedStream	form	bool	No
IsClosed	form	bool	No
KeepAlive	form	bool	No
HasStarted	form	bool	No
Items	form	Dictionary<string, Object>	No

**RequestAttributes** Enum:
Name	Value
None	0
Localhost	1
LocalSubnet	2
External	4
Secure	8
InSecure	16
AnySecurityMode	24
HttpHead	32
HttpGet	64
HttpPost	128
HttpPut	256
HttpDelete	512
HttpPatch	1024
HttpOptions	2048
HttpOther	4096
AnyHttpMethod	8160
OneWay	8192
Reply	16384
AnyCallStyle	24576
Soap11	32768
Soap12	65536
Xml	131072
Json	262144
Jsv	524288
ProtoBuf	1048576
Csv	2097152
Html	4194304
Wire	8388608
MsgPack	16777216
FormatOther	33554432
AnyFormat	67076096
Http	67108864
MessageQueue	134217728
Tcp	268435456
Grpc	536870912
EndpointOther	1073741824
AnyEndpoint	2080374784
InProcess	-2147483648
InternalNetworkAccess	-2147483645
AnyNetworkAccessType	-2147483641
Any	-1

**IRequestPreferences** Parameters:
Name	Parameter	Data Type	Required	Description
AcceptsGzip	form	bool	No
AcceptsDeflate	form	bool	No

**IHttpFile** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
FileName	form	string	No
ContentLength	form	long	No
ContentType	form	string	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.

POST /merchants HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ResellerKey: 0,
	MerchantName: String,
	MerchantId: String,
	AlternateMerchantId: String,
	AutoCloseBatch: False,
	AutoCloseBatchTimestamp: 0001-01-01,
	ForceDuplicate: False,
	RequirePNRef: False,
	IsTestMerchant: False,
	DefaultUserIsApiUser: False,
	ActivationStatus: String,
	PrimaryContact: 
	{
		LastName: String,
		FirstName: String,
		JobTitle: String,
		DepartmentName: String,
		EmailAddress: String,
		DaytimeTelephoneNumber: String,
		NighttimeTelephoneNumber: String,
		FaxNumber: String,
		MobileTelephoneNumber: String,
		BillingAddress: 
		{
			StreetAddress1: String,
			StreetAddress2: String,
			StreetAddress3: String,
			City: String,
			StateOrProvinceCode: String,
			PostalCode: String,
			CountryCode: String
		},
		ShippingAddress: 
		{
			StreetAddress1: String,
			StreetAddress2: String,
			StreetAddress3: String,
			City: String,
			StateOrProvinceCode: String,
			PostalCode: String,
			CountryCode: String
		}
	},
	BusinessInformation: 
	{
		DbaName: String,
		TelephoneNumber: String,
		Address: 
		{
			StreetAddress1: String,
			StreetAddress2: String,
			StreetAddress3: String,
			City: String,
			StateOrProvinceCode: String,
			PostalCode: String,
			CountryCode: String
		}
	},
	DefaultUser: 
	{
		UserName: String,
		PhoneNumber: String,
		Id: 0,
		DeleterUserId: 0,
		CreatorUserId: 0,
		LastModifierUserId: 0,
		IsLockoutEnabled: False,
		Roles: [],
		Logins: [],
		IsPhoneNumberConfirmed: False,
		SecurityStamp: String,
		IsTwoFactorEnabled: False,
		IsDeleted: False,
		IsEmailConfirmed: False,
		AccessFailedCount: 0,
		LockoutEndDateUtc: 0001-01-01,
		CreationTime: 0001-01-01,
		LastModificationTime: 0001-01-01,
		DeletionTime: 0001-01-01,
		FirstName: String,
		EmailConfirmationCode: String,
		Password: String,
		LastName: String,
		IsActive: False,
		EmailAddress: String,
		TenantId: 0,
		AuthenticationSource: String,
		PasswordResetCode: String,
		LastLoginTime: 0001-01-01,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Timezone: String,
		ShouldChangePasswordOnNextLogin: False
	},
	AccessSettings: 
	{
		BinManagementApi: False,
		DialIn: False,
		Internet: False
	},
	VirtualTerminalSettings: 
	{
		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
		}
	},
	FraudSettings: 
	{
		DailyVelocitySettings: 
		{
			Enabled: False,
			TransactionCount: 0,
			Action: Audit,
			EmailEnabled: False,
			EmailAddresses: String
		},
		IpFilteringSettings: 
		{
			Enabled: False,
			AllowedCountries: US,
			BlockedIpAddresses: String,
			Action: Audit,
			EmailEnabled: False,
			EmailAddresses: String
		},
		AmountSettings: 
		{
			Enabled: False,
			LowerLimit: 0,
			UpperLimit: 0,
			Action: Audit,
			EmailEnabled: False,
			EmailAddresses: String
		},
		HourlyVelocitySettings: 
		{
			Enabled: False,
			TransactionCount: 0,
			Action: Audit,
			EmailEnabled: False,
			EmailAddresses: String
		},
		TransactionIpVelocitySettings: 
		{
			Enabled: False,
			TransactionCountPerHour: 0,
			ExcludedIpAddresses: String,
			Action: Audit,
			EmailEnabled: False,
			EmailAddresses: String
		}
	},
	BillingSettings: 
	{
		ContractKey: 0,
		PricePlanKey: 0
	}
}

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

{
	
}

Syntch Gateway API

PostMerchant

Allowable Values

Allowable Values

Allowable Values

HTTP + JSV