Skip to main content

POS New Account Registration

Endpoint to start new account registration. Starts a new account registration **POST **/v2/pos//integrations/account/newRegistration

Headers

NameValueDescription
AuthorizationBearer Request authorization header
Content-Typeapplication/jsonContent type

Input parameters

Field nameDescription
posSystemThe identifier of the POS system (e.g., pax, clover)

Request

{
  "subscriptionPlanCode": "string",
  "sendToEmail": "user@example.com",
  "configuration": {
    "posCompanyId": "string",
    "posLocationId": "string",
    "externalUserId": "string",
    "terminalId": "string"
  },
  "profile": {
    "firstName": "string",
    "lastName": "string",
    "email": "user@example.com",
    "phoneNumber": "string",
    "state": "string",
    "address": "string",
    "city": "string",
    "zip": "string",
    "companyName": "string",
    "website": "string"
  }
}

Request parameters

Field nameDescription
subscriptionPlanCodeSubscription plan code, as a sample can be used 157AJME5XDSE2
sendToEmailEmail where registration email should be sent
configurationNew Registration configuration block
posCompanyIdPos company identifier (External company Identifier )
posLocationIdPos location identifier (External location Identifier )
externalUserIdExternal user identifier
terminalIdTerminal identifier
configurationData Block
firstNameContact person first name
lastNameContact person last name
emailCompany email
phoneNumberCompany phone number
stateCompany location state
addressCompany address
cityCompany city
zipCompany zip-code
companyNameCompany name
websiteCompany web-site