Use the /addWebUser
endpoint to create a new web user associated with one or more merchant accounts. If the request does not include any merchant codes, the web user is created, but not activated.
Request parameters
To create a new web user, make a POST /addWebUser
specifying:
Name | Type | Description | ||
---|---|---|---|---|
email |
String |
![]() |
The email address associated with the user account. |
|
merchantCodes |
Array |
![]() |
An array of merchant code strings. Format:
|
|
accountGroupCodes |
Array |
![]() |
An array of account group names. |
|
timeZoneCode |
String |
![]() |
The time zone associated to the user account profile. If you do not specify any value, the active user's time zone settings are used instead. |
|
userName |
String |
![]() |
A user name string holds the user account display name.
|
|
name |
Object |
![]() |
A container object for personal data. This object contains:
|
|
|-firstName |
String |
![]() |
The first name/given name of the user.
|
|
|-lastName |
String |
![]() |
The last name/family name of the user.
|
|
roles |
Array |
![]() |
A container object for types of role for the account user.
|
|
RoleType |
Enum |
![]() |
It defines the type of role assigned to the user account.
|
Response parameters
If there are no errors in the request, the call returns user name and password for the newly created user account, and a pspReference
.
If any issues occur during the process, the call returns one or more warning or error messages. In this case, no user name and no password data is included in the response.
Name | Type | Returned by default | Description |
---|---|---|---|
|
String |
![]() |
The user name assigned to the newly created account. |
|
String |
![]() | The password assigned to the newly created account. This is a temporary, one-time password. Users need to define a new one upon their first successful login. |
|
String |
![]() |
A reference to uniquely identify the request. |
|
Array |
![]() |
List containing one or more warning messages. |
|
Array |
![]() |
List containing one or more error messages. |