What are Integration Endpoints?
Integration endpoints handle merchant account registration and setup. Using these endpoints, you can:- Automated Onboarding: Register new merchant accounts programmatically
- Configuration Setup: Set up POS system, location, and terminal information
- Profile Creation: Create merchant profiles with business details
- Subscription Management: Link merchants to subscription plans
How It Works
Prepare Registration Data
Gather merchant information including business profile, POS configuration,
and subscription details.
Submit Registration
Call the new registration
endpoint with
complete merchant data.
Account Created
ClearLine creates the merchant account and sends setup instructions to the
provided email.
Complete Setup
Merchant receives email with login credentials and completes account
activation.
Integration Endpoint
Start Account Registration
Register a new merchant account with POS configuration
Required Information
When registering a new merchant account, you need to provide:Subscription Details
- Subscription plan code
- Email address for setup instructions
POS Configuration
- POS company ID
- POS location ID
- Terminal ID
- External user ID (your system’s merchant identifier)
Business Profile
- First name and last name (contact person)
- Email and phone number
- Company name
- Business address (street, city, state, zip)
- Website (optional)
Best Practices
Validate Data Before Submission
Validate Data Before Submission
Verify all required fields are complete and properly formatted before
calling the registration endpoint to avoid errors.
Use Unique External IDs
Use Unique External IDs
Provide unique external user IDs to easily map ClearLine accounts back to
your system for ongoing management.
Handle Email Delivery
Handle Email Delivery
Inform merchants to check their email (including spam folder) for setup
instructions after registration.
Store Registration Response
Store Registration Response
Save the response data linking your merchant ID to the ClearLine account for
future API operations.
Implement Error Handling
Implement Error Handling
Handle registration errors gracefully - duplicate accounts, invalid
subscription codes, or missing required fields.