| Required role: | Merchant |
| POST | /merchants/users | Creates a new gateway user for the specified merchant. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | model | int | Yes | |
| GatewayUser | model | PostUserRequest | Yes | |
| IsApiUser | model | bool | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"MerchantKey":0,"GatewayUser":{"UserName":"String","FirstName":"String","LastName":"String","EmailAddress":"String","PhoneNumber":"String","Password":"String","IsActive":false,"IsLockoutEnabled":false,"IsTwoFactorEnabled":false,"Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","ShouldChangePasswordOnNextLogin":false},"IsApiUser":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"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-01T00:00:00.0000000","CreationTime":"0001-01-01T00:00:00.0000000","LastModificationTime":"0001-01-01T00:00:00.0000000","DeletionTime":"0001-01-01T00:00:00.0000000","FirstName":"String","EmailConfirmationCode":"String","Password":"String","LastName":"String","IsActive":false,"EmailAddress":"String","TenantId":0,"AuthenticationSource":"String","PasswordResetCode":"String","LastLoginTime":"0001-01-01T00:00:00.0000000","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","Timezone":"String","ShouldChangePasswordOnNextLogin":false}