POS New Account Registration

Endpoint to start new account registration. Starts a new account registration **POST ** https://apitest.clearline.me/v2/pos/{posSystemId}/integrations/account/newRegistration

Pre-provisioned plans

Some plans are delivered as a start up application the merchant installs from their POS system. For those plans the merchant registration already exists: a Partner creates it in the Admin portal and the merchant is sent the application install link. When you call this endpoint with such a plan, ClearLine connects the installation to that registration instead of starting a new one:

the registration waiting on the same plan is updated with the profile and POS identifiers you send;
the registration email with the account link is sent to sendToEmail, so the merchant can activate the registration they were provisioned with;
calling the endpoint again for the same POS company updates the same registration, so a repeated installation never produces a duplicate merchant.

Only a registration created within the last 24 hours can be connected this way. If none is found, or the plan is not delivered as a start up application, a new registration is created exactly as described below.

Headers

Name	Value	Description
Authorization	Bearer access_token	Request authorization header
Content-Type	application/json	Content type

Input parameters

Field name	Description
posSystem	The 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 name	Description
subscriptionPlanCode	Subscription plan code, as a sample can be used 157AJME5XDSE2
sendToEmail	Email where registration email should be sent
configuration	New Registration configuration block
posCompanyId	Pos company identifier (External company Identifier )
posLocationId	Pos location identifier (External location Identifier )
externalUserId	External user identifier
terminalId	Terminal identifier
configuration	Data Block
firstName	Contact person first name
lastName	Contact person last name. Optional, first name is used if omitted
email	Company email
phoneNumber	Company phone number
state	Company location state
address	Company address
city	Company city
zip	Company zip-code
companyName	Company name
website	Company web-site

Getting Started

Integration Options

POS Integration

API Reference

New Account Registration

POS New Account Registration

Pre-provisioned plans

Headers

Input parameters

Request

Request parameters

​POS New Account Registration

​Pre-provisioned plans

​Headers

​Input parameters

​Request

​Request parameters

POS New Account Registration

Pre-provisioned plans

Headers

Input parameters

Request

Request parameters