List

GET 
/listMerchantUsers/:merchantGuid

Returns the merchant users of the given merchant.

Request

Query Parameters

merchantGuid stringrequired

Identifier of the merchant.

Responses

200

The merchants of the given tenant.

application/json

Schema

Schema

success booleanrequired

Whether the request was successful or not.

merchantUser object[]

List of merchant users of a merchant.

Array [

username string

Possible values: >= 3 characters

type MerchantUserTyperequired

Possible values: [web, api]

email email

Mandatory for web users.

password string

Mandatory for

• api users
• web users if sendInitialPassword is false

firstName string

lastName string

validUntil date-time

disabled boolean

Default value: false

multiMerchantAccess string[]

List of merchant GUIDs the user can access, overwrites existing list.

merchantAccess MerchantLink[]

List of merchants the user can access.

Array [

name string

Possible values: >= 3 characters

]

permissions MerchantUserPermission[]

Possible values: [frontend.dashboard.payout-forecast, frontend.dashboard.financial-summary, frontend.blacklist.show, frontend.blacklist.edit, frontend.blacklist.show-admin-values, frontend.whitelist.show, frontend.whitelist.edit, frontend.whitelist.show-admin-values, frontend.payment-template.edit, frontend.show-connectors.real-connectors, frontend.show-connectors.meta-connectors, frontend.transaction.detailed-fees, frontend.transaction.adapter-txid-visible, frontend.transaction.risk-check-result, frontend.transaction.data-export, frontend.transaction.refund, frontend.transaction.void, frontend.transaction.capture, frontend.transaction.settlement-state, frontend.virtual-terminal.use, frontend.virtual-terminal.register, frontend.virtual-terminal.surcharge, frontend.postprocessing.documents, frontend.schedule.start, frontend.schedule.show, frontend.schedule.pause, frontend.schedule.continue, frontend.schedule.cancel, frontend.schedule.retry, frontend.customer-profiles.show, frontend.customer-profiles.prefer, frontend.customer-profiles.update, frontend.customer-profiles.delete, frontend.customer-profiles.detach, frontend.customer-profiles.deregister-and-detach, frontend.customer-profiles.transactions, frontend.representment.show]

For web users only: permissions of the user.

sendInitialPassword boolean

For web users only: send an initial password via email.

apiUserSettings object

push-api booleannullable

fees-api booleannullable

cde-login-enabled booleannullable

snapshot-retrieval-enabled booleannullable

]

property name* any

Example (from schema)

{
  "success": true,
  "merchantUser": [
    {
      "guid": "string",
      "username": "string",
      "type": "web",
      "email": "[email protected]",
      "createdAt": "2001-02-03T04:05:06+02:00",
      "requirePasswordChange": true,
      "passwordValidUntil": "2001-02-03T04:05:06+02:00",
      "firstName": "string",
      "lastName": "string",
      "validUntil": "2001-02-03T04:05:06+02:00",
      "disabled": false,
      "archived": false,
      "merchantAccess": [
        {
          "guid": "string",
          "name": "string"
        }
      ],
      "permissions": [
        "frontend.dashboard.payout-forecast"
      ],
      "apiUserSettings": {
        "push-api": true,
        "fees-api": true,
        "cde-login-enabled": true,
        "snapshot-retrieval-enabled": true
      }
    }
  ]
}

401

Unauthorized, see authentication.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
errorMessage stringrequired

Human readable error message.

:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::

property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1000

Unauthorized (1000)

{
  "success": false,
  "errorCode": 1000,
  "errorMessage": "Unauthorized"
}

422

Unprocessable entity.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
errorMessage stringrequired

Human readable error message.

:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::

property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1001

Unprocessable entity (1001)

{
  "success": false,
  "errorCode": 1001,
  "errorMessage": "Unauthorized"
}

500

Internal server error.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
errorMessage stringrequired

Human readable error message.

:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::

property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1001

Internal server error (9999)

{
  "success": false,
  "errorCode": 9999,
  "errorMessage": "Internal server error"
}

Loading...