Create

POST 
/createMerchantUser/:merchantGuid

Create a merchant user for the given merchant.

Request

Path Parameters

merchantGuid stringrequired

Identifier of the merchant.

application/json

Body

required

The merchant user to create.

username string

Possible values: >= 3 characters

type MerchantUserType (string)required

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
Example: 2001-02-03T04:05:06+02:00
disabled boolean
Default value: false
multiMerchantAccess string[]

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

permissions MerchantUserPermission (string)[]

For web users only: permissions of the user.

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

sendInitialPassword boolean

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

apiUserSettings

object

push-api booleannullable

fees-api booleannullable

pay-by-link-api booleannullable

cde-login-enabled booleannullable

snapshot-retrieval-enabled booleannullable

Responses

200

The created merchant user.

application/json

Schema

Schema

success booleanrequired

Whether the request was successful or not.

merchantUser

object

guid stringrequired

Identifier.

username string

Possible values: >= 3 characters

type MerchantUserType (string)required

Possible values: [web, api]

email email

Mandatory for web users.

createdAt date-time

Example: 2001-02-03T04:05:06+02:00

requirePasswordChange boolean

Whether a password change is required.

passwordValidUntil date-time

Example: 2001-02-03T04:05:06+02:00

firstName string

lastName string

validUntil date-time

Example: 2001-02-03T04:05:06+02:00

disabled boolean

Default value: false

archived boolean

Example: false

merchantAccess

MerchantLink[]

List of merchants the user can access.

Array [

guid string

Identifier.

name string

Possible values: >= 3 characters

]

permissions MerchantUserPermission (string)[]

For web users only: permissions of the user.

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

apiUserSettings

object

push-api booleannullable

fees-api booleannullable

pay-by-link-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.blacklist.edit"
    ],
    "apiUserSettings": {
      "push-api": true,
      "fees-api": true,
      "pay-by-link-api": true,
      "cde-login-enabled": true,
      "snapshot-retrieval-enabled": true
    }
  }
}

Example

{
  "success": true,
  "merchantUser": {
    "guid": "US-1234-1234-1234-1234-1234-1234",
    "username": "my.user",
    "email": "[email protected]",
    "type": "web",
    "createdAt": "2020-12-18 14:04:55",
    "archived": false,
    "disabled": false,
    "validUntil": "2025-10-10 00:00:00",
    "firstName": "Alex",
    "lastName": "Smith",
    "requirePasswordChange": true,
    "passwordValidUntil": null,
    "merchantAccess": [
      {
        "guid": "ME-1234-1234-1234-1234-1234-1234",
        "name": "Merchant A"
      },
      {
        "guid": "ME-4321-4321-4321-4321-4321-4321",
        "name": "Merchant B"
      }
    ],
    "permissions": "frontend.blacklist.show frontend.blacklist.edit"
  }
}

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
Example: 1004
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. :::
Example: name: nameInvalid characters
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
Example: 1004
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. :::
Example: name: nameInvalid characters
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
Example: 1004
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. :::
Example: name: nameInvalid characters
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...