Create user

Creates a new user.

Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

Include at least the email address and value for the role of this new user.

Request parameters

  • email
  • role -merchantIds

Response parameters

  • message
Body Params
string
required

The new user's email address.

string
enum
required

The new user's role. Determines their level of access.

Possible values include the following:

  • R - View-Only, has the ability to view data
  • W - Standard, can perform actions on data such as void, refund process, etc.
  • A - Admin, has all the permissions of a standard user and can also create and edit other users
Allowed:
merchantIds
array of strings

The merchant IDs the new user will be able to access.

merchantIds
Responses

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json