Deposits
Get all deposits
Get all deposits
GET
{base url}/v1/deposits
Get all deposits
Query Parameters
page
number
perPage
number
Get deposit details
Get deposit details
GET
{base url}/v1/deposits/_single
Get single deposit details
Query Parameters
depositId*
string
Get deposit account balances
Get deposit account balances
GET
{base url}/v1/deposits/{depositId}/balances
Get deposit account balances
Get deposit transactions
Get deposit transactions
GET
{base url}/v1/deposits/transactions
Get all deposit transactions
Query Parameters
accountNumber*
string
Add deposits
Add new deposit
POST
{base url}/v1/deposits/transactions
Add new deposit
Request Body
productId*
string
deposit product Id
accountNumber*
string
account number
type*
string
type
amount*
number
amount (major)
narration*
string
narration
applyManualFee*
boolean
apply manual fees
exemptAutoFees*
boolean
exempt auto fees
manualFee
object
manual fees
Deposit withdrawal
Deposit withdrawal
POST
{base url}/v1/deposits/transactions
Deposit withdrawal
Request Body
productId*
string
depositt product id
accountNumber*
string
account number
type*
string
type
amount*
number
amount (major)
narration*
string
narration
applyManualFee*
boolean
apply manual fees
exemptAutoFees*
boolean
exempt auto fees
manualFee
object
manual fees
Deposit transfer
Deposit transfer
POST
{base url}/v1/deposits/transactions/transfer
Deposit transfer
Request Body
productId*
string
deposit product Id
senderAccountNumber*
string
sender account number
receiverAccountNumber*
string
receiver account number
amount*
number
amount (major)
narration*
string
narration
applyManualFee*
boolean
apply manual fees
exemptAutoFees*
boolean
exempt auto fees
create deposit
Create deposit
POST
{base url}/v1/deposits
create deposit
Headers
Authorization header
*
String
API user secret key
Body
depositProductId
*
string
deposit product Id
accountName
*
string
deposit account name
accountHolder
*
string
account holder Id
accountHolderType
*
string
account holder type (clients/deposits)
depositTenure
string
deposit tenure
depositInterestRate
number
deposit interest rate
status
string
deposit status
Response
Pre liquidate account
Pre liquidate account
POST
{base url}/v1/deposits/{depositId}/pre_liquidate
pre liquidate account
Headers
Authorization header
*
String
API user secret key
Body
newAccountNumber
*
string
new account number
Response
liquidate account
Liquidate account
POST
{base url}/v1/deposits/{depositId}/liquidate
Liquidate account
Headers
Authorization header
*
String
API user secret key
Body
newAccountNumber
*
string
new account number
Response
apply accrued interest
Apply accrued interest
POST
{base url}/v1/deposits/{accountNumber}/apply_interest
apply accrued interest
Headers
Authorization header
*
String
API user secret key
Response
Last updated