Default icon

Get a web user

Get user account information.

Request parameters

To get detailed web user account information, make a POST /getWebUser request specifying

NameTypeRequiredDescription

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)

Response parameters

If there are no errors in the request, the call returns detailed information about the specified user account.

If any issues occur during the process, the call returns an error message.

Name Type Returned by default Description
pspReference

String
-white_check_mark-

A reference to uniquely identify the request.

active

Boolean
-white_check_mark-

  • true: the account is active.

  • false: the account is inactive.

email

String
-x-

The email address associated with the user account.

merchantCodes

List
-white_check_mark-

A list holding merchant code strings.A merchant code string holds a value to identify a merchant.

Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code
accountGroupCodes

Array
-white_check_mark-

An array of account group names.
For example: ["groupEU", "groupUS"].
roles

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

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

A container object for personal data. This object contains:

  • firstName
  • lastName
|-firstName

String
-x-

The first name/given name of the user.

  • Max. length: 80 characters
  |-lastName

String
-x-

The last name/family name of the user.

  • Max. length: 80 characters

Examples

Request

Response