Vendors
The Vendors section enables administrators to manage merchant accounts, agent accounts, and their team members.
Screenshots
Vendors List
Vendor Detail
Vendors List
Table Columns
| Column | Description |
|---|---|
| Business | Name and owner |
| Type | Merchant, Agent, Hybrid |
| Status | Active, Pending, Suspended |
| Verification | Verified, Pending, Rejected |
| Tills | Number of active tills |
| Volume | Total transaction volume |
| Actions | View, Edit, Manage |
Search & Filters
| Filter | Options |
|---|---|
| Search | Business name, owner |
| Type | All, Merchant, Agent, Hybrid |
| Status | All, Active, Pending, Suspended |
| Verification | All, Verified, Pending, Rejected |
Add Vendor Wizard
Steps
| Step | Title | Fields |
|---|---|---|
| 1 | Business Info | Name, type, category, registration, address, phone, email |
| 2 | Owner Details | Owner name, ID, phone, email |
| 3 | Documents | Registration, tax clearance, owner ID, proof of address |
| 4 | Review | Review all information before submission |
Business Types
| Type | Description |
|---|---|
| Merchant | Accepts payments only |
| Agent | Top-up and withdrawal services |
| Hybrid | Both merchant and agent services |
Vendor Details
Detail Page Tabs
| Tab | Description |
|---|---|
| Overview | Business information and stats |
| Team | Team members and sub-users |
| Tills | Active tills and history |
| Transactions | Vendor's transactions |
| Documents | KYC documents |
Overview Fields
| Field | Description |
|---|---|
| Business Name | Registered name |
| Business Type | Merchant, Agent, Hybrid |
| Category | Business category |
| Registration Number | Company registration |
| Tax Number | Tax identification |
| Address | Business address |
| Phone | Contact phone |
| Contact email | |
| Owner | Owner name and contact |
Sub-User Management
Team Member Fields
| Field | Description |
|---|---|
| Name | Member's full name |
| Username | Login username |
| Role | Admin, Cashier, Custom |
| Status | Active, Suspended |
| Permissions | Assigned permissions |
Available Permissions
| Permission | Description |
|---|---|
pos | Accept payments |
topup | Process top-ups |
withdraw | Process withdrawals |
transactions.own | View own transactions |
transactions.all | View all transactions |
reports.view | View reports |
reports.export | Export reports |
team.view | View team |
team.manage | Manage team |
cards | Card operations |
KYC Documents
Required Documents
| Document | Description |
|---|---|
| Business Registration | Company registration certificate |
| Tax Clearance | Tax clearance certificate |
| Owner ID | Owner's identity document |
| Proof of Address | Business address proof |
| Bank Statement | Recent bank statement |
Document States
| State | Description |
|---|---|
| Not Uploaded | Document missing |
| Pending | Awaiting review |
| Approved | Document verified |
| Rejected | Document not accepted |
API Endpoints
| Endpoint | Method | Description |
|---|---|---|
/admin/vendors | GET | List vendors |
/admin/vendors | POST | Create vendor |
/admin/vendors/:id | GET | Vendor details |
/admin/vendors/:id | PATCH | Update vendor |
/admin/vendors/:id/team | GET | Vendor team |
/admin/vendors/:id/team | POST | Add team member |
/admin/vendors/:id/team/:memberId | PATCH | Update member |
/admin/vendors/:id/team/:memberId/permissions | PUT | Set permissions |
/admin/vendors/:id/tills | GET | Vendor tills |
/admin/vendors/:id/documents | POST | Upload document |
/admin/vendors/:id/verify | POST | Verify vendor |
Related Files
| File | Purpose |
|---|---|
src/pages/vendors/VendorsPage.tsx | List page |
src/pages/vendors/VendorDetailPage.tsx | Detail page |
src/components/vendors/ | Vendor components |
src/services/vendorService.ts | API service |
src/types/vendor.ts | Type definitions |