Command Palette

Search for a command to run...

B
Request

Recurring Deposit Accounts

Manage recurring deposit accounts with scheduled deposits and maturity tracking

List recurring deposit accountsRetrieve recurring deposit accountSubmit new recurring deposit applicationMake recurring deposit installment
GET
/fineract-provider/api/v1/recurringdepositaccounts

List recurring deposit accounts

Retrieves a list of all recurring deposit accounts.

Query Parameters

sqlSearchstring

SQL-style search

offsetinteger

Pagination offset

limitinteger

Maximum results

Returns

200List of recurring deposit accounts

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/recurringdepositaccounts" \
  --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/recurringdepositaccounts/{accountId}

Retrieve recurring deposit account

Gets detailed information about a specific recurring deposit account.

Path Parameters

accountIdintegerrequired

Account ID

Returns

200Recurring deposit account details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/recurringdepositaccounts/: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/recurringdepositaccounts

Submit new recurring deposit application

Creates a new recurring deposit account application.

Request Bodyrequired

Recurring deposit details

clientIdinteger
productIdinteger
submittedOnDatestring
mandatoryRecommendedDepositAmountnumber
depositPeriodinteger
depositPeriodFrequencyIdinteger
recurringFrequencyinteger
recurringFrequencyTypeinteger
expectedFirstDepositOnDatestring
dateFormatstring
localestring

Returns

200Recurring deposit created

Request

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

Response

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

Make recurring deposit installment

Records a deposit installment for the recurring deposit account.

Path Parameters

accountIdintegerrequired

Account ID

Request Bodyrequired

Deposit details

transactionDatestring
transactionAmountnumber
paymentTypeIdinteger
dateFormatstring
localestring

Returns

200Deposit recorded

Request

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

Response

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

Was this page helpful?