Get All Fixed Deposit Accounts

GET /fixed-deposit/accounts

Description

Retrieves all fixed deposit accounts with flexible filtering options. This endpoint allows the use of various query parameters to narrow down the results based on specific criteria.

Headers:

Name	Type	Description
countryCode	string	The country code (required).

Query Parameters:

Name	Type	Description
filterByUserId	string	Filter by user ID.
filterByUuid	string	Filter by unique identifier.
filterBySourceAccount	string	Filter by source account.
filterByStatus	string	Filter by status.
filterByProductId	string	Filter by product ID.
filterByOwnerId	string	Filter by owner ID.
filterBySavingAccountId	string	Filter by saving account ID.
filterByRolloverId	string	Filter by rollover ID.
filterByCurrency	string	Filter by currency type.
filterByTenantId	string	Filter by tenant ID.
filterByHasRollover	boolean	Filter by rollover status.
filterByProcessCompleted	boolean	Filter by whether the process is completed.
filterByMatured	boolean	Filter by matured accounts.
filterByPrematureClosure	boolean	Filter by premature closure status.
filterByTransactionId	string	Filter by transaction ID.
filterByReference	string	Filter by reference ID.
filterByRequestId	string	Filter by request ID.
filterByTenantUserId	string	Filter by tenant user ID.
filterBySourceAccountCredited	boolean	Filter by source account credited status.
filterByTerminationType	string	Filter by termination type.
filterByTransactionStatus	string	Filter by transaction status.
filterByPrematureClosureDate	string	Filter by premature closure date (format: yyyy-MM-dd).
pageNumber	integer	The page number for pagination. Default: 1.
pageSize	integer	The number of results per page. Default: 10.
filterByMaturityDate	string	Filter by maturity date (format: yyyy-MM-dd).
startDate	string	Filter by start date (format: yyyy-MM-dd HH:mm).
endDate	string	Filter by end date (format: yyyy-MM-dd HH:mm).

Example Request:

curl -X GET "{{baseURL}}/fixed-deposit/accounts" \
     -H "Authorization: Bearer [access_token]" \
     -H "countryCode: [countryCode]" \
     -G \
     --data-urlencode "filterByUserId=12345" \
     --data-urlencode "filterByStatus=ACTIVE" \
     --data-urlencode "pageNumber=1" \
     --data-urlencode "pageSize=10" \
     --data-urlencode "startDate=2024-01-01 00:00" \
     --data-urlencode "endDate=2024-12-31 23:59"

Sample Response: 200

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "data": {},
      "descriptiveMessage": "string"
    }
  ]
}