Docs
Powered by

# Admin Panel

The Admin Panel provides administrative features for managing the HivePay platform.

# Accessing Admin Panel

  1. Log in with an admin API key
  2. Navigate to /admin in the dashboard
  3. Admin features appear in the sidebar

# Merchant Management

# List All Merchants

View all registered merchants:

Column Description
ID Merchant identifier
Name Business name
Hive Account Payment destination
Status Active/Inactive
Created Registration date

# Search Merchants

Use the search box to find merchants by:

  • Merchant ID
  • Business name
  • Hive account

# Filter by Status

  • All - Show all merchants
  • Active - Active merchants only
  • Inactive - Deactivated merchants

# Merchant Actions

# View Merchant Details

Click on a merchant to see:

  • Full merchant information
  • Payment statistics
  • Recent payments
  • Webhook configuration

# Activate/Deactivate Merchant

Toggle a merchant's active status:

  1. Find the merchant in the list
  2. Click the status toggle or action menu
  3. Confirm the action
// Activate a merchant
await hivepay.admin.setActive('merchant_id', true);

// Deactivate a merchant
await hivepay.admin.setActive('merchant_id', false);

# Bulk Operations

# Export Merchants

Export merchant list to CSV:

  1. Apply filters if needed
  2. Click Export
  3. Choose format (CSV or JSON)
  4. Download file

# Pagination

Navigate large merchant lists:

  • Items per page: 20, 50, 100
  • Previous/Next navigation
  • Jump to specific page

# System Statistics

The admin dashboard shows platform-wide statistics:

Metric Description
Total Merchants Number of registered merchants
Active Merchants Currently active merchants
Total Payments All-time payment count
Today's Payments Payments created today
Processing Volume Total HIVE/HBD processed

# API Access

Admin endpoints require an API key with admin privileges:

# List Merchants 

// Get paginated list
const result = await hivepay.admin.listMerchants({
  page: 1,
  limit: 50,
  query: 'store'  // Optional search
});

console.log(result.data);  // Array of merchants
console.log(result.pagination.total);  // Total count

# Iterate All Merchants 

// Async iteration
for await (const merchant of hivepay.admin.iterateMerchants()) {
  console.log(merchant.id, merchant.name, merchant.isActive);
}

// With filters
for await (const merchant of hivepay.admin.iterateMerchants({
  query: 'store',
  pageSize: 50
})) {
  // Process merchant
}

# Audit Logging

Admin actions are logged for security:

  • Merchant activation/deactivation
  • Settings changes
  • Access timestamps

Contact the HivePay team for audit log access.

# Self-Hosted Deployments

If you're running your own HivePay instance:

  1. Admin privileges are configured during deployment
  2. See the deployment documentation for setup
  3. Admin users are defined in the database seed

HivePay © 2026