Skip to main content

Managing Merchants

Learn how to add, edit, and manage merchant accounts in the Admin Dashboard.

Adding a New Merchant​

See the Adding Merchants guide for detailed instructions on:

  • Form fields and validation
  • Domain normalization (host-only input, canonical https://host)
  • What happens when you submit
  • Field mapping reference
  • Error handling

Quick steps:

  1. Click the "+ Add Merchant" button in the top right of the merchants table
  2. Fill in Company Name, Domain, and optional fields
  3. Click "Add Merchant" to create the account

Editing a Merchant​

See the Merchant Page Editing guide for the primary inline editing flow, including:

  • Editing merchant profile fields directly on the merchant page
  • FinMatch ID validation and uniqueness checks
  • Environment synchronization and integrity checks
  • Save/cancel behavior and API-backed persistence

Quick steps:

  1. Find the merchant in the table
  2. Click the merchant name (or "⋯" → "✏️ Edit")
  3. Click "Edit Merchant" on the merchant page
  4. Update the merchant information (including FinMatch ID if needed)
  5. Click "Save Changes"

Legacy modal-specific docs remain in Editing Merchants for reference.

Viewing Merchant Details​

  1. Find the merchant in the table
  2. Click the merchant name in the table (or "⋯" → "✏️ Edit")

The merchant detail view shows:

  • Merchant Information - ID, company name, company number, domain, testing domain, CreditSafe link
  • Stripe Billing - Customer ID, name, email, phone, address, billing status
  • Contact Information - Contact type, name, email, phone
  • Lender Configuration - Enabled lenders and credit products
  • App Settings - Environment, snippet status, features

Deleting a Merchant​

  1. Open the merchant detail page
  2. Click "Delete Merchant"
  3. Type delete in the confirmation prompt
  4. Confirm deletion

Deletion is handled by DELETE /api/merchants/:id, which removes:

  • Merchant profile entry in merchants.json
  • Merchant routing entry in merchant-router.json
  • Merchant domains from CORS policy

Searching and Filtering​

Use the search box to find merchants by:

  • Merchant ID
  • Company Name
  • Domain/URL

The search automatically filters as you type.

Filters​

Use the filter dropdowns to narrow results:

  • Status - Filter by Active, Pending, or Suspended
  • Environment - Filter by Production, Staging, or Test
  • Items per page - Control how many merchants are displayed (25, 50, 100, 200)

Linking Stripe Customers​

  1. Find the merchant in the table
  2. Click "🔗 Link Customer" in the Stripe Customer column (if not already linked)
  3. Or click "⋯" → "🔗 Manage Stripe" to link or update the Stripe connection
  4. Enter the Stripe Customer ID or search for the customer
  5. Save the connection

Once linked, the Stripe Customer column will show the customer ID as a clickable link.

Exporting Merchant Data​

The merchants table supports exporting data:

  • Use browser extensions or copy/paste to export table data
  • All visible columns are included in the export

Best Practices​

  • Use Descriptive Company Names - Make it easy to identify merchants in the list
  • Keep Domains Updated - Ensure merchant domains are current for accurate deployment monitoring
  • Link Stripe Early - Connect Stripe customers when setting up new merchants
  • Use Environments Correctly - Use Test/Staging for development, Production for live merchants

Next Steps​