Skip to main content

Get Wallet By Company API

Overview​

Retrieves active company wallet status, total credit limit, and current available balance.

  • Endpoint: /api/wallet/get-by-company
  • Method: POST

Request Body Schema​

FieldTypeRequiredDescription
companyIdString (UUID)YesTarget company ID

Request Body Example​

{
"companyId": "comp_12345678"
}

Response Example (200 OK)​

{
"success": true,
"data": {
"companyId": "comp_12345678",
"companyName": "Acme Corp",
"wallet": {
"id": "wlt_11223344",
"companyId": "comp_12345678",
"balance": 579840.00,
"currency": "INR",
"active": true,
"createdAt": "2026-10-07T00:00:00.000Z",
"updatedAt": "2026-10-07T00:00:00.000Z"
},
"totalCredited": 1000000.00,
"totalDebited": 420160.00,
"recentTransactions": [
{
"id": "tx_99887766",
"companyId": "comp_12345678",
"walletId": "wlt_11223344",
"transactionType": "CREDIT",
"amount": 100000.00,
"balanceAfter": 579840.00,
"referenceId": "REQ-TOPUP-12345",
"description": "Top-up via Bank Transfer",
"status": "COMPLETED",
"createdAt": "2026-10-07T00:00:00.000Z",
"updatedAt": "2026-10-07T00:00:00.000Z"
}
]
},
"message": "Company wallet details retrieved successfully"
}