Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Add a web user

Create a new web user for one or more merchant accounts.

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
Required
Description
email String
-white_check_mark-
The email address associated with the user account.
merchantCodes Array
-x-
An array of merchant code strings.
A merchant code string holds a value to identify a merchant. Format:
  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code
timeZoneCode String
-white_check_mark-
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
-white_check_mark-
A user name string holds the user account display name.
It can include:
  • Digits: 0-9
  • Letters a-z, A-Z
  • Special characters: "." (dot), "-" (hyphen), "_" (underscore)
name Object
-white_check_mark-
A container object for personal data. This object contains:
  • firstName
  • infix
  • lastName
|-firstName String
-white_check_mark-
The first name/given name of the user.
  • Max. length: 80 characters
  |-infix String
-x-
Infix in the user account's name.
  • Max. length: 20 characters
  |-lastName String
-white_check_mark-
The last name/family name of the user.
  • Max. length: 80 characters
  |-gender String
-white_check_mark-
Defines the gender of the user.
Allowed values:
  • MALE
  • FEMALE
  • UNKNOWN
roles Array
-x-

A container object for types of role for the account user.

  • RoleType
RoleType Enum
-x-
It defines the type of role assigned to the user account.
Some examples of roles are:
  • Merchant_standard_role
  • Merchant_manage_payments
  • Merchant_Report_role
  • Merchant_dispute_management
  • Merchant_technical_integrator
  • Merchant_View_Risk_Results_role
  • Merchant_view_risk_settings
  • Merchant_change_risk_settings 
  • Merchant_allowed_own_password_reset

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
userName String
-x-
The user name assigned to the newly created account.
password String
-x-
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.
pspReference String
-white_check_mark-
A reference to uniquely identify the request.
warnings Array
-x-
List containing one or more warning messages.
Returned when the request is not correctly processed.
errors Array
-x-
List containing one or more error messages.
Returned when the request fails.

Examples

Request

{
   "email":"test@test.nl",
   "merchantCodes":[
      "MerchantAccount.TestMerchant",
   ],
   "name":{
      "firstName":"Jane",
      "gender":"FEMALE",
      "lastName":"Doe"
   },
   "timeZoneCode":"UTC",
   "userName":"test"
}
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soap:Body>
        <addWebUser xmlns="http://caaccount.services.adyen.com">
            <request>
                <email>test@test.nl</email>
                <merchantCodes>
                    <string>MerchantAccount.TestMerchant</string>
                </merchantCodes>
                <name>
                    <firstName xmlns="http://common.services.adyen.com">Jane</firstName>
                    <gender xmlns="http://common.services.adyen.com">FEMALE</gender>
                    <lastName xmlns="http://common.services.adyen.com">Doe</lastName>
                </name>
                <timeZoneCode>UTC</timeZoneCode>
                <userName>test</userName>
            </request>
        </addWebUser>
    </soap:Body>
</soap:Envelope>

Response

{
   "pspReference":"9914526950450289",
   "password": "*******",
   "userName": "testuser"
}
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns0="http://caaccount.services.adyen.com">
    <soap:Body>
        <ns0:addWebUserResponse>
            <ns0:response>
                <ns0:pspReference>9914526950450289</ns0:pspReference>
                <ns0:password>*******</ns0:password>
                <ns0:userName>testuser</ns0:userName>
            </ns0:response>
        </ns0:addWebUserResponse>
    </soap:Body>
</soap:Envelope>

Response in case of an error

{  
  "pspReference":"9914368689030052",
  "errors":[  
    "8_008 lacks permission to merchant 'TestMerchantNotExists1'"
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns0="http://caaccount.services.adyen.com">
    <soap:Body>
        <ns0:addWebUserResponse>
            <ns0:response>
                <ns0:errors>
                    <ns0:string>8_008 lacks permission to merchant 'TestMerchantNotExists1'</ns0:string>
                </ns0:errors>
                <ns0:pspReference>9914368689030052</ns0:pspReference>
            </ns0:response>
        </ns0:addWebUserResponse>
    </soap:Body>
</soap:Envelope>