v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Create Account (Team Member)

Create a new account (team member) for this merchant (Administrator role only).

post/v3/account

Query parameters

echoboolean

Request body

activeboolean required

Is this user active?

saleLimitnumber float

Highest payment amount this user can make

refundLimitnumber float

Highest refund amount this user can make

rolestring required

What role does this user need? Values: Administrator, Supervisor, Read Only, Clerk, No Access

usernamestring required

Username of the new user

firstNamestring

User's first name

lastNamestring

User's last name

emailstring

User's email address

mobilestring

User's phone number

passwordstring

User's new or temporary password

Response

201

activeboolean

saleLimitinteger

refundLimitinteger

photostring

rolestring

usernamestring

firstNamestring

lastNamestring

emailstring

mobilestring

passwordstring

Example response

{
  "active": true,
  "saleLimit": 1000,
  "refundLimit": 1000,
  "timeRestriction": {
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "endTimeMinute": 1439
  },
  "merchants": [
    {
      "id": 110070419,
      "dba": "Demo Test TSYS Merchant",
      "xmid": 8739290300300001,
      "applicationStatus": "0",
      "plan": "Basic",
      "package": [
        "Basic"
      ],
      "address": {
        "name": "Location",
        "address1": "1234 TEST ST",
        "city": "ALPHARETTA",
        "state": "GA",
        "zip": "30004",
        "country": "USA"
      }
    }
  ],
  "role": "Supervisor",
  "username": "apidocstest",
  "firstName": "API",
  "lastName": "Test",
  "email": "docs@pps.io",
  "mobile": "1234567890",
  "password": "Password1234!"
}