Activation Codes

User Story:

As a merchant, when i receive a PAX Device i want to signup via ISO Activation Code, so that i could be linked to my ISO Partner and i would not be billed during the onboarding and afterworth As an ISO Partner, I want to configure the device and preinstall apps, entering the ISO Activation code from the coupon, so that i could link device to my ISO Partner account and billing.

Interactive Prototypes:

Activation Codes Signup Flow Activation Codes Link Device to Existing Account Flow

Hierarchy:

Super admin - Has multiple activation codes for multiple partners
1. Partner - has multiple activation codes only for his partnership
  1. Public Brand 1
    1. Account 1
  2. Public Brand 2
    1. Account 1 - has only one activation code
      1. Activation Code - has multiple devices
        
        Device 1 - has only one activation code
        
        Device 2
    2. Account 2 - has only one activation code
      1. Activation Code - has multiple devices
        
        Device 1
        
        Device 2

Base Success Flow Chart Diagram:

Base Success Flow and Endpoints:

Enter Activation code and Register account /pos/{posSystemId}/integrations/account/registration
Send Activation Code by email /pos/{posSystemId}/activationCode/{activationCode}/send
Get Activation Code status to login user after account creation /pos/{posSystemId}/activationCode/{activationCode}/status
Get available locations list /pos/{posSystemId}/activationCode/{activationCode}/locations
Use activation code to link terminal to account /pos/{posSystemId}/activationCode/{activationCode}/use

Super/Partner Admin Creates Activation code
1. Opens Activation Codes List
2. Clicks Create Single Activation Code
3. System opens the Single Activation Code Creation modal
4. Super admin Fills all fields
  1. Enters name
  2. Selects Partner via the autocomplete
  3. Selects No Brand option
  4. Selects Pricing Plan
  5. Selects Payment Party
    1. Partner - Onboarding without Payment step
    2. Account Owner - Onboarding with payment step
5. Super Admin Confirms creation
6. System creates Activation Code and shows it in the Activation codes list
Super admin clicks selects the send option from the grid context menu
System opens the Send modal
Super Admin selects the Email option, enters email and clicks send
System sends the Activation Code and New registration Url to the entered email
Merchant Starts PAX Clearline app
App shows the Activation Code screen
Merchant Enters the Activation code
App calls clearline API https://apitest.clearline.me/swagger/index.html#/PosIntegrations/PosIntegrations_AccountRegistration
If the Activation code is valid
Clearline API returns code 200 and Registration URL to Android APP
If there is no account, Clearline generates New registration and short url
1. App opens a QR Code and Email input screen
2. Merchant Scans QR Code or enters email and clicks the New registration URL on his own device
  1. If Merchant Scans QR code - System opens Short URL
  2. If Merchant Enters Email
    1. App Calls Send Endpoint https://apitest.clearline.me/swagger/index.html#/PosActivationCode/PosActivationCode_SendAccountActivationCode
      1. Endpoint should have system account authorization
      2. App should call the Client Credentials Authorization(should be included in PAX tasks)
    2. Clearline API sends an email using new template that will be a copy of the Send template but saying “Dear Merchant” instead of “Dear (customer name)” ❓⚠️
3. Merchant opens registration URL on his personal device
4. System opens the Signup screen (without social networks)
5. User enters his details and creates an account
6. User proceeds to onboarding
7. System redirects user from mobile device to PC Onboarding
  1. If payment party Partner - Onboarding without Payment step
  2. If payment party Account Owner - Onboarding with payment step
8. User Completes the onboarding
9. PAX App calls “Get Activation Code Registration Status” endpoint each 15 seconds
  https://apitest.clearline.me/swagger/index.html#/PosActivationCode/PosActivationCode_GetActivationCodeStatus
10. Clearline App authorizes Merchant to the App
If the account was already created by acitvation code or New registration url, Then the device should be added to account and user is logged in as device.
1. App Requests Locations of the existing account
  https://apitest.clearline.me/swagger/index.html#/PosActivationCode/PosActivationCode_Locations
2. App shows Select location and Serial number Screen/Modal to select existing location
  1. Select Existing Location Dropdown with autocomplete
  2. Enter Device Serial Number input (Shown only if the App failed to get the Serial number)
  3. Cancel, Select buttons
3. Merchant Selects locations and enters Device Serial Number
4. Merchant Accepts Terms of Use
5. Application calls the Activation code Usage endpoint
  https://apitest.clearline.me/swagger/index.html#/PosActivationCode/PosActivationCode_UseActivationCode
  1. Request data:
    1. Activation Code, (Required)
    2. LocationID, (Required)
    3. TerminalID/Serial number (Required)
    4. AcceptedTermsOfUse (required)
6. Clearline API creates new terminal with Serial Number of the Device
7. Clearline API Links Terminal(device) to Activation Code
8. If Merchant has the QR Code screen opened
  1. Merchant clicks the Validate button
  2. App shows the select Location and Serial number modal
  3. Merchant selects location and enters serial number
9. If Merchant has closed the QR Code screen
  1. Merchant Enters Activation Code
  2. Merchant Selects location and Enters Device Serial number
Application Automatically Authorizes the Device to the CMC Portal
Application saves the Activation code to some Androind secure storage