Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Update a web user account

Update an existing web user's account information.

This call supports full and partial updates:

  • All the populated fields in the update request are updated;
  • Any non-mandatory fields excluded from the operation are skipped.

For a field to be updated correctly, it needs to be completely populated. For example, to update an element that contains child elements, all the mandatory child elements must be populated with valid data.
If one or more mandatory sub-elements are missing from the update request, the whole parent element fails to update, and its value does not change.

When you make a POST /updateWebUser request, take the following guidelines into account:

  • grantRoles: Update per role.
  • revokeRoles: Update per role.
  • name and email are related fields; therefore, they both need to be completely populated in the update request, even when you want to update only one of them.
  • This implies also that if the update fails for either name or email, the other related element is not updated, either.
  • addMerchantCodes: Update per merchantCode.
  • deleteMerchantCodes: Update per merchantCode.

Request parameters

To update web user account information, make a POST /updateWebUser request specifying:

Name Type
Required
Description
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)
active Boolean
-x-
  • Set to true to activate an account.
  • Set to false to make the account inactive.
addMerchantCodes

List

-x-
A list holding merchant codes you want to activate and associate with the specified user account.

A merchant code string holds a value to identify a merchant. Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code

Merchant codes in this list should not be included in deleteMerchantCodes as well.

deleteMerchantCodes

List

-x-
A list holding merchant codes you want to make inactive and remove from the specified user account.

 A merchant code string holds a value to identify a merchant. Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code

Merchant codes in this list should not be included in addMerchantCodes as well.

email String
-x-
The email address associated with the user account.
grantRoles List
-x-
New roles you want to assign to the specified user account.
  • RoleType

Roles in this list should not be included in revokeRoles as well.

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
revokeRoles List
-x-
Assigned roles you want to revoke from the specified user account.
  • RoleType

Roles in this list should not be included in grantRoles as well.

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
timeZoneCode String
-x-
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.
name Object
-x-
A container object for personal data. This object contains:
  • firstName
  • infix
  • lastName
|-firstName String
-x-
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
-x-
The last name/family name of the user.
  • Max. length: 80 characters
  |-gender String
-x-
Defines the gender of the user.
Allowed values:
  • MALE
  • FEMALE
  • UNKNOWN

Response parameters

If there are no errors in the request, the call returns a pspReference.If any issues occur during the process, the call returns one or more warning or error messages.

Name Type Returned by default Description
pspReference String
-white_check_mark-
A reference to uniquely identify the request.
warnings String

-x-
List containing one or more warning messages.
Returned when the request is not correctly processed.
errors String
-x-
List containing one or more error messages.
Returned when the request fails.

Examples

Request

{
   "active":"true",
   "addMerchantCodes":[
      "MerchantAccount.TestMerchant"
   ],
   "deleteMerchantCodes":[
      "TestMerchantDelete"
   ],
   "email":"test@email.ad",
   "grantRoles":[
      "Merchant_change_risk_settings"
   ],
   "name":{
      "firstName":"Jane",
      "gender":"FEMALE",
      "lastName":"Green"
   },
   "revokeRoles":[
      "Merchant_technical_integrator",
      "Merchant_dispute_management"
   ],
   "timeZoneCode":"UTC",
   "userName":"merchant1"
}
<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>
    <updateWebUser xmlns="http://caaccount.services.adyen.com">
      <request>
        <active>true</active>
        <email>test@email.ad</email>
        <addMerchantCodes>
          <string>MerchantAccount.TestMerchant</string>
        </addMerchantCodes>
        <deleteMerchantCodes>
          <string>TestMerchantDelete</string>
        </deleteMerchantCodes>
        <grantRoles>
          <RoleType>Merchant_change_risk_settings</RoleType>
        </grantRoles>
        <name>
          <firstName>Jane</firstName>
          <gender>FEMALE</gender>
          <lastName>Doe</lastName>
        </name>
        <revokeRoles>
          <RoleType>Merchant_technical_integrator</RoleType>
          <RoleType>Merchant_dispute_management</RoleType>
        </revokeRoles>
        <timeZoneCode>UTC</timeZoneCode>
        <userName>merchant1</userName>
      </request>
    </updateWebUser>
  </soap:Body>
</soap:Envelope>

Response

{
   "pspReference":"9914140700917468"
}
<?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:updateWebUserResponse>
            <ns0:response>
                <ns0:pspReference>9914140700917468</ns0:pspReference>
            </ns0:response>
        </ns0:updateWebUserResponse>
    </soap:Body>
</soap:Envelope>

Response in case of an error or warning

{
   "pspReference":"9914140700710438",
   "warnings":[
      "8_041 failed revokeRoles 'Merchant_dispute_management': not even granted"
   ]
}
<?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:updateWebUserResponse>
            <ns0:response>
                <ns0:pspReference>9914140700710438</ns0:pspReference>
                <ns0:warnings>
                    <ns0:string>8_041 failed revokeRoles 'Merchant_dispute_management': not even granted</ns0:string>
                </ns0:warnings>
            </ns0:response>
        </ns0:updateWebUserResponse>
    </soap:Body>
</soap:Envelope>