Add Frequent Savings
The "Add Frequent Savings" endpoint allows customers to create a new frequent savings pocket.
POST /api/savingsaccount/v1/frequentsavings/add
To create a frequent savings account, you need to provide the necessary body parameters, such as pocketName, liquidationAccount, productCode, amount, and other relevant details.
Headers
Content-Type*
application/json
Authorization*
Bearer
Request-Reference*
{unique_reference}
Body
pocketName
string (100)
Details of the savings, e.g. Rent, School Fees.
liquidationAccount
string (10)
This is the Customer Account that will be debited for the Savings.
amount
number
The Principal Amount. Amount should be sent in the base unit of the currency. For example, 1000 naira will be sent as 1000 * 100.
deductionAmount
Integer
The amount to be deducted till the Target Amount is reached. Deduction Amount should be sent in the base unit of the currency. For example, 1000 naira will be sent as 1000 * 100.
productCode
string (3)
The Fixed Deposit Product Code. Must be an active Fixed Deposit Product Code that exists on the CBA portal.
frequency
Integer
How often the deduction towards the savings occurs. Enum (Daily = 1, Weekly = 2, Monthly = 3)
commencementDate
Integer
The start date of the frequent savings.
maturityDate
Integer
The maturity date of the frequent savings.
interestRate
Integer
The applicable interest rate for the savings. Percentage should be in at most 3 decimal places.
useDefaultInterestRate
boolean
Set true to use the product's default interest rate, or false to apply the custom interestRate supplied instead.
preferredTime
Integer
The preferred time for the deduction to occur. Preferred Time ranges from 0 to 23.
accountCreationChannel
string
The channel through which this savings account is being created, e.g. Mobile, Web, USSD, or API.
imageURL
string
A URL pointing to an image associated with the savings pocket, for example, a goal image representing what the pocket is saving towards (Rent, School Fees, etc).
targetSavingsURL
string
A URL associated with the target savings goal, likely used for reference or tracking on the client side.
Here is an example request and response with a sample payload sent to the endpoint in Curl format.
Last updated