Skip to main content

Create

POST 

/createMerchantUser/:merchantGuid

Create a merchant user for the given merchant.

Request

Query Parameters

    merchantGuid stringrequired

    Identifier of the merchant.

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
    disabled boolean
    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 (string)[]

    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]

    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

Responses

The created merchant user.

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
    requirePasswordChange boolean

    Whether a password change is required.

    passwordValidUntil date-time
    firstName string
    lastName string
    validUntil date-time
    disabled boolean
    archived boolean

    merchantAccess

    MerchantLink[]

    List of merchants the user can access.

  • Array [

  • guid string

    Identifier.

    name string

    Possible values: >= 3 characters

  • ]

  • permissions MerchantUserPermission (string)[]

    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]

    For web users only: permissions of the user.

    apiUserSettings

    object

    push-api booleannullable
    fees-api booleannullable
    cde-login-enabled booleannullable
    snapshot-retrieval-enabled booleannullable
    property name* any
Loading...