Command Palette

Search for a command to run...

B
Request

Fixed Deposit Accounts

Manage fixed deposit accounts with maturity tracking, premature closure, and interest calculations

List fixed deposit accountsRetrieve fixed deposit accountSubmit new fixed deposit applicationPremature close fixed depositCalculate premature closure amount
GET
/fineract-provider/api/v1/fixeddepositaccounts

List fixed deposit accounts

Retrieves a list of all fixed deposit accounts.

Query Parameters

sqlSearchstring

SQL-style search

externalIdstring

Filter by external ID

offsetinteger

Pagination offset

Returns

200List of fixed deposit accounts

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/fixeddepositaccounts" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/fixeddepositaccounts/{accountId}

Retrieve fixed deposit account

Gets detailed information about a specific fixed deposit account.

Path Parameters

accountIdintegerrequired

Account ID

Query Parameters

associationsstring

Include associated data

Returns

200Fixed deposit account details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/fixeddepositaccounts/:accountId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
POST
/fineract-provider/api/v1/fixeddepositaccounts

Submit new fixed deposit application

Creates a new fixed deposit account application.

Request Bodyrequired

Fixed deposit account details

clientIdinteger
productIdinteger
submittedOnDatestring
depositAmountnumber

Deposit amount

depositPeriodinteger

Deposit period

depositPeriodFrequencyIdinteger

Period frequency type

externalIdstring
dateFormatstring
localestring

Returns

200Fixed deposit created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/fixeddepositaccounts" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "clientId": 1,
  "productId": 1,
  "submittedOnDate": "01 January 2024",
  "depositAmount": 1000,
  "depositPeriod": 1,
  "depositPeriodFrequencyId": 1,
  "externalId": "sample_externalId",
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
POST
/fineract-provider/api/v1/fixeddepositaccounts/{accountId}?command=prematureClose

Premature close fixed deposit

Closes a fixed deposit account before its maturity date, potentially with penalty.

Path Parameters

accountIdintegerrequired

Account ID

Request Bodyrequired

Premature closure details

closedOnDatestring
onAccountClosureIdinteger

Closure type (transfer/withdrawal)

toSavingsAccountIdinteger

Target savings account

paymentTypeIdinteger
notestring
dateFormatstring
localestring

Returns

200Fixed deposit closed prematurely

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/fixeddepositaccounts/:accountId?command=prematureClose" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "closedOnDate": "01 January 2024",
  "onAccountClosureId": 1,
  "toSavingsAccountId": 1,
  "paymentTypeId": 1,
  "note": "sample_note",
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
POST
/fineract-provider/api/v1/fixeddepositaccounts/{accountId}?command=calculatePrematureAmount

Calculate premature closure amount

Calculates the amount that would be received if the fixed deposit is closed prematurely.

Path Parameters

accountIdintegerrequired

Account ID

Request Bodyrequired

Calculation date

closedOnDatestring
dateFormatstring
localestring

Returns

200Premature amount calculated

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/fixeddepositaccounts/:accountId?command=calculatePrematureAmount" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "closedOnDate": "01 January 2024",
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}

Was this page helpful?