--
:
--
:
--

API Reference

37 endpoints — interactive JSON response viewer

Standard Response Format

GET list / paginated:

{
  "success": true,
  "message": "...",
  "data": [...],
  "pagination": {
    "totalItems": n,
    "totalPages": n,
    "currentPage": 1,
    "pageSize": 10
  }
}

GET single:

{ "success": true, "message": "...", "data": { ... } }

Standard Filter Query Format

Filter দিয়ে GET করতে filters query param এ JSON string পাঠাতে হয়।

{
  "and": { "fieldName__eq": "value" },
  "or":  { "fieldName__like": "term" }
}

Operators:

__eq— exact match__like— partial match__gte— ≥ (date from)__lte— ≤ (date to)

Example:

?page=1&length=10&filters={"and":{"businessStatus__eq":"APPROVED","createdAt__gte":"2026-04-22"},"or":{"businessName__like":"gold","BID__like":"gold"}}

Conversations

8
GET
Get all conversations (paginated)support-svc/business-app/conversations
No request body
{
"success": true
"message": "Conversations fetched successfully"
"data": [[1 item]]
"pagination": {{totalItems, totalPages, …}}
}
GET
Get messages by conversation IDsupport-svc/business-app/messages/{conversationId}
No request body
{
"success": true
"message": "Messages fetched successfully"
"data": [[2 items]]
}
POST
Send message in a new conversationsupport-svc/business-app/messages
{
"success": true
"message": "Message sent successfully"
"data": {{inboxChunkSupport}}
}
POST
Send reply in existing conversationsupport-svc/business-app/messages/{conversationId}
{
"success": true
"message": "Message sent successfully"
}
PATCH
Mark conversation event (seen / delivered)support-svc/business-app/conversations/{conversationId}/event
{
"success": true
"message": "Conversation marked as seen successfully"
"data": {{conversationId, isSeen, …}}
}
PATCH
Close a conversationsupport-svc/business-app/conversations/{conversationId}/close
{
"success": true
"message": "Conversation closed successfully"
"data": {{conversationId, status, …}}
}
PATCH
Transfer conversation to another agentsupport-svc/business-app/conversations/{conversationId}/transfer
{
"success": true
"message": "Conversation transferred successfully"
"data": {{conversationId, status, …}}
}
PATCH
Change/link trade account to conversationsupport-svc/business-app/conversations/{conversationId}
{
"success": true
"message": "Conversation updated successfully"
"data": {{tradeAccountId, tradeAccountNumber}}
}

Users

3
GET
Get current logged-in user infouser-svc/user-app/get-single-user
No request body
{
"success": true
"message": "User fetched successfully"
"data": {{_id, name, …}}
}
PATCH
Update agent online/offline statussupport-svc/business-app/users/{userId}
{
"success": true
"message": "Online status updated"
}
GET
Get users (filter by businessId / userId / isOnline)support-svc/business-app/users
No request body
{
"success": true
"message": "Online users fetched successfully"
"data": [[1 item]]
"pagination": {{totalItems, totalPages, …}}
}

Businesses

1
GET
Get enrolled businesses (paginated)support-svc/business-app/enrolled-businesses
No request body
{
"success": true
"message": "Enrolled businesses fetched successfully"
"data": [[2 items]]
"pagination": {{totalItems, currentPage, …}}
}

Integrations & Templates

3
GET
Get WhatsApp templatessupport-svc/business-app/templates
No request body
{
"success": true
"message": "Template names retrieved successfully (from cache)"
"data": [[8 items]]
}
GET
Get all WhatsApp integrationsintegration-svc/business-app/integrations
No request body
{
"success": true
"message": "Integrations fetched successfully"
"data": [[1 item]]
}
POST
Create/update WhatsApp integrationintegration-svc/business-app/setup/{businessId}
{
"success": true
"message": "Integration setup successfully"
}

Trade Accounts

4
GET
Get unique users by businessvirtual-trading-svc/business-app/account/unique-users
No request body
{
"success": true
"message": "Unique users fetched successfully"
"data": [[1 item]]
}
GET
Get all accounts by business & uservirtual-trading-svc/business-app/trade-accounts
No request body
{
"success": true
"message": "Accounts fetched successfully"
"data": [[1 item]]
}
GET
Get trade account summaryvirtual-trading-svc/business-app/trade/account-summary
No request body
{
"success": true
"message": "Account summary fetched successfully"
"data": {{_id, userId, …}}
}
GET
Get trading account logsvirtual-trading-svc/business-app/trade/account-log
No request body
{
"success": true
"message": "Account log fetched successfully"
"data": {{account, transactions, …}}
}

Trades

10
GET
Get active trades listvirtual-trading-svc/business-app/trade/active-trades
No request body
{
"success": true
"message": "Active trades fetched successfully"
"data": [[1 item]]
"pagination": {{totalItems, totalPages, …}}
}
GET
Get pending trades listvirtual-trading-svc/business-app/trade/pending-trades
No request body
{
"success": true
"message": "Pending trades fetched successfully"
"data": [[1 item]]
"pagination": {{totalItems, totalPages, …}}
}
POST
Open a new tradevirtual-trading-svc/business-app/trade/open
{
"success": true
"message": "Trade opened successfully"
"data": {{tradeId, tradeType, …}}
}
POST
Open/submit a pending tradevirtual-trading-svc/business-app/trade/open-pending
{
"success": true
"message": "Pending trade created successfully"
"data": {{tradeId, pendingTradeType, …}}
}
POST
Close a single active tradevirtual-trading-svc/business-app/trade/close
{
"success": true
"message": "Trade closed successfully"
}
POST
Close partial active tradevirtual-trading-svc/business-app/trade/close-partial-v2
{
"success": true
"message": "Partial trade closed successfully"
}
POST
Close all active tradesvirtual-trading-svc/business-app/trade/close-all
{
"success": true
"message": "All trades closed successfully"
}
PATCH
Modify an active trade (SL/TP)virtual-trading-svc/business-app/trade/modify-active-trade
{
"success": true
"message": "Trade modified successfully"
}
PATCH
Modify a pending tradevirtual-trading-svc/business-app/trade/modify-pending-trade
{
"success": true
"message": "Pending trade modified successfully"
"data": {{tradeId, tradeType, …}}
}
POST
Remove a pending tradevirtual-trading-svc/business-app/trade/remove-pending-trade
{
"success": true
"message": "Pending trade deleted successfully"
"data": {{tradeType, triggerRate, …}}
}

Statements & Settings

4
POST
Get/toggle auto statement statusvirtual-trading-svc/business-app/trade/auto-statement-status
{
"success": true
"message": "Auto statement status fetched successfully"
"data": {{autoStatement}}
}
GET
Get statement data (for PDF generation)virtual-trading-svc/business-app/trade/generate-statement
No request body
{
"success": true
"message": "Statement data fetched successfully"
"data": {{summary, dailyCompletedTrades}}
}
GET
Get business trading settings (admin)virtual-trading-svc/admin-app/trade/business/settings
No request body
{
"success": true
"message": "Settings fetched successfully"
"data": {{_id, tradingCharge, …}}
}
GET
Get business trading settings (business)virtual-trading-svc/business-app/business/settings
No request body
{
"success": true
"message": "Settings fetched successfully"
"data": {{_id, tradingCharge, …}}
}

Market & Notifications

4
GET
Get current gold market pricemarket-price/{timestamp}
No request body
{
"success": true
"message": "Market price fetched successfully"
"data": {{k21Price, k22Price, …}}
}
GET
Get gold price history rangemarket-price/?startTime={start}&endTime={end}
No request body
{
"success": true
"message": "Price history fetched successfully"
"data": [[2 items]]
}
GET
Get notification logs (paginated)virtual-trading-svc/business-app/notifications
No request body
{
"success": true
"message": "Notifications fetched successfully"
"data": [[1 item]]
"pagination": {{totalItems, currentPage, …}}
}
PATCH
Mark notifications as readvirtual-trading-svc/business-app/notification-logs/mark-as-read
{
"success": true
"message": "Notifications marked as read"
}