Skip to main content

Get Deposit Activities

Retrieve all activities related to a specific deposit account. This is a convenience query that wraps GetActivitiesQuery with entity type set to Deposit.

Command​

Use GetActivitiesQuery with entity: "Deposit":

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Deposit",
    "entityId": "12345",
    "pageSize": 50
  }
}

Request Parameters​

ParameterTypeRequiredDescription
entitystringYesMust be "Deposit"
entityIdstringNo*Database ID of the deposit
encodedKeystringNo*Deposit's encoded key
startDatestringNoStart date filter (YYYY-MM-DD)
endDatestringNoEnd date filter (YYYY-MM-DD)
pageNumberintegerNoPage number (default: 1)
pageSizeintegerNoItems per page (default: 50)

*Either entityId or encodedKey is required.

Examples​

Using Deposit ID​

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Deposit",
    "entityId": "12345",
    "startDate": "2025-01-01",
    "pageSize": 100
  }
}

Using Deposit Encoded Key​

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Deposit",
    "encodedKey": "8a80866e7f456789",
    "pageSize": 50
  }
}

Response Example​

{
  "Status": "00",
  "Message": "Activities retrieved successfully",
  "Data": {
    "activities": [
      {
        "Id": 3001,
        "CreationDate": "2025-12-24T09:30:00",
        "UserName": "teller@banklingo.com",
        "UserKey": "8a80866e7f123456",
        "Action": "Create",
        "ActivityDescription": "Savings account opened",
        "AffectedItemType": "DepositAccount",
        "AffectedDepositName": "Premium Savings Account",
        "AffectedDepositEncodedKey": "8a80866e7f456789",
        "AffectedDepositId": "DEP-2025-00456"
      },
      {
        "Id": 3002,
        "CreationDate": "2025-12-24T10:00:00",
        "UserName": "teller@banklingo.com",
        "Action": "Deposit",
        "ActivityDescription": "Cash deposit - Amount: ₦50,000",
        "AffectedItemType": "DepositAccount",
        "AffectedDepositName": "Premium Savings Account",
        "AffectedDepositEncodedKey": "8a80866e7f456789",
        "AffectedDepositId": "DEP-2025-00456"
      },
      {
        "Id": 3003,
        "CreationDate": "2025-12-24T15:30:00",
        "UserName": "customer.service@banklingo.com",
        "Action": "Status Change",
        "ActivityDescription": "Account status changed to Active",
        "AffectedItemType": "DepositAccount",
        "AffectedDepositName": "Premium Savings Account",
        "AffectedDepositEncodedKey": "8a80866e7f456789",
        "AffectedDepositId": "DEP-2025-00456"
      }
    ],
    "totalRows": 12,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 50
  }
}

TypeScript Example​

async function getDepositActivities(depositId: string, startDate?: string): Promise<ActivityResponse> {
  const response = await fetch('/api/core/cmd', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${token}`
    },
    body: JSON.stringify({
      Cmd: 'GetActivitiesQuery',
      Data: {
        entity: 'Deposit',
        entityId: depositId,
        startDate: startDate,
        pageSize: 50
      }
    })
  });

  return await response.json();
}

// Usage
const activities = await getDepositActivities('12345', '2025-01-01');
console.log(`Deposit has ${activities.Data.totalRows} activities`);

Common Activity Types for Deposits​

  • Create: Deposit account opened
  • Update: Account details updated
  • Deposit: Funds deposited
  • Withdrawal: Funds withdrawn
  • Transfer: Funds transferred in/out
  • Interest: Interest credited
  • Fee: Service charge applied
  • Status Change: Account status changed (Active, Dormant, Closed)
  • Maturity: Fixed deposit matured
  • Renewal: Fixed deposit renewed

Use Cases​

Account Activity History​

View complete history of a deposit account:

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Deposit",
    "encodedKey": "8a80866e7f456789",
    "pageSize": 100
  }
}

Transaction Audit​

Track all deposit and withdrawal activities:

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Deposit",
    "entityId": "12345",
    "startDate": "2025-12-01",
    "pageSize": 50
  }
}

Interest Calculation Verification​

Verify interest credit activities:

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Deposit",
    "entityId": "12345",
    "searchText": "Interest",
    "startDate": "2025-01-01",
    "pageSize": 50
  }
}

Account Status Changes​

Track status changes for dormant account monitoring:

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Deposit",
    "encodedKey": "8a80866e7f456789",
    "searchText": "Status",
    "pageSize": 50
  }
}

Note: Activities track account-level events. For detailed transaction history, use the Deposits Transaction API.