Syntch Gateway API

PostMerchantUser

Administration - Merchant Management

**Requires Authentication**
Required role:	Merchant

The following routes are available for this service:
POST	/merchants/users	Creates a new gateway user for the specified merchant.

**PostMerchantUser** Parameters:
Name	Parameter	Data Type	Required
MerchantKey	model	int	Yes
GatewayUser	model	PostUserRequest	Yes
IsApiUser	model	bool	Yes

**PostUserRequest** Parameters:
Name	Parameter	Data Type	Required
UserName	form	string	No
FirstName	form	string	No
LastName	form	string	No
EmailAddress	form	string	No
PhoneNumber	form	string	No
Password	form	string	No
IsActive	form	bool	No
IsLockoutEnabled	form	bool	No
IsTwoFactorEnabled	form	bool	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
ShouldChangePasswordOnNextLogin	form	bool	No

**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

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.

POST /merchants/users HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostMerchantUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Users.BindingModels">
  <GatewayUser>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <City>String</City>
    <Country>String</Country>
    <EmailAddress>String</EmailAddress>
    <FirstName>String</FirstName>
    <IsActive>false</IsActive>
    <IsLockoutEnabled>false</IsLockoutEnabled>
    <IsTwoFactorEnabled>false</IsTwoFactorEnabled>
    <LastName>String</LastName>
    <Password>String</Password>
    <PhoneNumber>String</PhoneNumber>
    <ShouldChangePasswordOnNextLogin>false</ShouldChangePasswordOnNextLogin>
    <State>String</State>
    <UserName>String</UserName>
    <Zip>String</Zip>
  </GatewayUser>
  <IsApiUser>false</IsApiUser>
  <MerchantKey>0</MerchantKey>
</PostMerchantUser>

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

<GatewayUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.User.Domain.BindingModels">
  <AccessFailedCount>0</AccessFailedCount>
  <Address1>String</Address1>
  <Address2>String</Address2>
  <AuthenticationSource>String</AuthenticationSource>
  <City>String</City>
  <Claims xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Identity.Domain.BindingModels" i:nil="true" />
  <Country>String</Country>
  <CreationTime>0001-01-01T00:00:00</CreationTime>
  <CreatorUserId>0</CreatorUserId>
  <DeleterUserId>0</DeleterUserId>
  <DeletionTime>0001-01-01T00:00:00</DeletionTime>
  <EmailAddress>String</EmailAddress>
  <EmailConfirmationCode>String</EmailConfirmationCode>
  <FirstName>String</FirstName>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <IsDeleted>false</IsDeleted>
  <IsEmailConfirmed>false</IsEmailConfirmed>
  <IsLockoutEnabled>false</IsLockoutEnabled>
  <IsPhoneNumberConfirmed>false</IsPhoneNumberConfirmed>
  <IsTwoFactorEnabled>false</IsTwoFactorEnabled>
  <LastLoginTime>0001-01-01T00:00:00</LastLoginTime>
  <LastModificationTime>0001-01-01T00:00:00</LastModificationTime>
  <LastModifierUserId>0</LastModifierUserId>
  <LastName>String</LastName>
  <LockoutEndDateUtc>0001-01-01T00:00:00</LockoutEndDateUtc>
  <Logins xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Identity.Domain.BindingModels" />
  <Password>String</Password>
  <PasswordResetCode>String</PasswordResetCode>
  <PhoneNumber>String</PhoneNumber>
  <Roles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Identity.Domain.BindingModels" />
  <SecurityStamp>String</SecurityStamp>
  <ShouldChangePasswordOnNextLogin>false</ShouldChangePasswordOnNextLogin>
  <State>String</State>
  <TenantId>0</TenantId>
  <Timezone>String</Timezone>
  <UserName>String</UserName>
  <Zip>String</Zip>
</GatewayUser>