Add Fixed Deposit

The "Add Fixed Deposit" endpoint allows customers to add a fixed deposit account. POST /api/fixeddepositaccount/v1/add To create a new fixed deposit account, you need to provide the necessary body parameters, such as referenceNumber, liquidationAccount, principalAmount, and other relevant details.

Headers

Name	Value
Content-Type*	application/json
Authorization*	Bearer <token>
Request-Reference	{unique-reference}

Body

Name	Data Type (length)	Required	Description
liquidationAccountType	string		The type of account where funds will be liquidated The enumerations are: 1 = SavingsAndCurrent (Default) 2 = GeneralLedgerAccount
liquidationAccount	string (1		The account number where funds will be liquidated
customerID	string (1		The unique identifier of the customer (individual or group), is only optional if the liquidationType is SavingsAndCurrent It must be a customerID that exists on the CBA portal.
referenceNumber	string		A unique reference number for the fixed deposit account
productCode	string		The product code associated with the fixed deposit account The productCode must exist on the CBA portal.
branchCode	string		The branch code where the fixed deposit account is being created is only optional if the liquidationType is SavingsAndCurrent The branchCode must exist on the CBA portal. The system will use the account branch if empty or null.
principalAmount	integer		The principal amount being deposited into the fixed deposit account The amount should be sent in the base unit of the currency. For example, 1000 naira will be sent as 1000 * 100.
tenure	integer		The tenure or duration of the fixed deposit in months
commencementDate	date		The start date of the fixed deposit
useProductInterestRate	boolean		Set true to use the default interest rate of the product and false for no
applicableInterestCode	string		The interest code should be applied if you are not using the product's default interest rate.
applicableInterestRate	integer		The interest rate to apply if not using the product's default The percentage must be rounded to a maximum of three decimal places.
partLiquidationCharge	integer		The charge applied if the fixed deposit is partially liquidated The percentage must be rounded to a maximum of three decimal places.
holdFundAtMaturity	boolean		Indicates whether to hold the funds in the account at maturity, Set true for yes and false for no
applyRollover	boolean		Indicates whether to apply rollover at maturity
rolloverOption	string		The rollover option to apply The enumerations are: 1 = RolloverPrincipalOnly 2 = RolloverPrincipalAndInterest

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/fixeddepositaccount/v1/add' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "liquidationAccountType": "string",
  "liquidationAccount": "string",
  "customerID": "string",
  "referenceNumber": "string",
  "productCode": "string",
  "branchCode": "string",
  "principalAmount": 0,
  "tenure": 0,
  "commencementDate": "2023-01-20T23:43:25.269Z",
  "useProductInterestRate": true,
  "applicableInterestCode": "string",
  "applicableInterestRate": 0,
  "partLiquidationCharge": 0,
  "holdFundAtMaturity": true,
  "applyRollover": true,
  "rolloverOption": "string"
}'

Respose: 200

{
  "status": true,
  "message": "string",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}