Deposits
Get all deposits
Get all deposits
GET {base url}/v1/deposits
Get all deposits
Query Parameters
page
number
perPage
number
{
"responseCode": "00",
"status": "success",
"message": "Deposits fetch successful",
"data": [
{
"id": "844e2eaa-61a1-4099-8407-55a4b24df294",
"organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
"depositProductId": "aeec33a0-059f-4a4a-b122-357eec1572c2",
"accountNumber": "0000000692",
"accountName": "new depo 34",
"accountHolder": "05768940-15ed-450c-8d8e-70f36ffffff8",
"accountHolderType": "companies",
"depositTenure": null,
"accruedInterest": 0,
"customData": {},
"accountBalance": 19000,
"accountLedgerBalance": 19000,
"maturityDate": null,
"status": "active",
"updated_at": "2023-12-12T00:01:02.256Z",
"firstName": null,
"lastName": null,
"clientkey": null,
"name": "chowDeck",
"accountholdername": "chowDeck",
"companykey": "05768940-15ed-450c-8d8e-70f36ffffff8",
"productName": "new product 1000",
"productType": "savings_account"
},
{
"id": "4fd1318b-668b-4562-a216-cd2490fd03ed",
"organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
"depositProductId": "aeec33a0-059f-4a4a-b122-357eec1572c2",
"accountNumber": "0000000678",
"accountName": "testing34567",
"accountHolder": "05768940-15ed-450c-8d8e-70f36ffffff8",
"accountHolderType": "companies",
"depositTenure": null,
"accruedInterest": 0,
"customData": {},
"accountBalance": 8500,
"accountLedgerBalance": 8500,
"maturityDate": null,
"status": "active",
"updated_at": "2023-12-12T00:01:02.272Z",
"firstName": null,
"lastName": null,
"clientkey": null,
"name": "chowDeck",
"accountholdername": "chowDeck",
"companykey": "05768940-15ed-450c-8d8e-70f36ffffff8",
"productName": "new product 1000",
"productType": "savings_account"
},
{
"id": "bfca1acb-23e0-4ad4-a163-ed4481ed6d7e",
"organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
"depositProductId": "aeec33a0-059f-4a4a-b122-357eec1572c2",
"accountNumber": "0000000465",
"accountName": "sdsdsds",
"accountHolder": "05768940-15ed-450c-8d8e-70f36ffffff8",
"accountHolderType": "companies",
"depositTenure": null,
"accruedInterest": 0,
"customData": {},
"accountBalance": 1000,
"accountLedgerBalance": 1000,
"maturityDate": null,
"status": "closed",
"updated_at": "2023-09-04T08:36:32.009Z",
"firstName": null,
"lastName": null,
"clientkey": null,
"name": "chowDeck",
"accountholdername": "chowDeck",
"companykey": "05768940-15ed-450c-8d8e-70f36ffffff8",
"productName": "new product 1000",
"productType": "savings_account"
}
],
"pagination": {
"currentPage": 1,
"perPage": 30,
"totalCount": 52,
"totalPages": 2,
"previousPage": 0,
"nextPage": 2
}
}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
{
"responseCode": "00",
"status": "success",
"message": "Deposits balances fetch successful",
"data": {
"ledger balance": 8500,
"available balance": 8500
}
}Get deposit transactions
Get deposit transactions
GET {base url}/v1/deposits/transactions
Get all deposit transactions
Query Parameters
accountNumber*
string
{
"status": "success",
"message": "Transactions fetched successfully",
"data": [],
"pagination": {
"currentPage": 1,
"perPage": 15,
"totalCount": 0,
"totalPages": 0,
"previousPage": 0,
"nextPage": 0
}
}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
{
"responseCode": "00",
"message": "deposit added successfully"
}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
{
"responseCode": "00",
"message": "deposit withdrawal successful"
}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
{
"responseCode": "00",
"message": "deposit transfer successful"
}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
{
"responseCode": "00",
"status": "success",
"message": "Deposit created successfully",
"data": {
"organizationId": "aee1a803-3835-4195-b732-a19f7c3702c8",
"accountHolderType": "clients",
"accountHolder": "d4c9f36f-ffbb-4c85-87cb-97c8fee6b9ad",
"accountName": "testing",
"depositTenure": 24,
"accountNumber": "0000000396",
"depositInterestRate": 0,
"status": "active",
"customData": {},
"depositProduct": {
"id": "cc795c3d-1eb1-4099-b46f-0f25e121bd74",
"organizationId": "aee1a803-3835-4195-b732-a19f7c3702c8",
"productName": "march 8",
"productType": "current_account",
"productUserType": [
"clients",
"companies"
],
"productCurrency": "NGN",
"productDescription": "nil",
"productInterestRate": {
"applyInterest": false
},
"productTransactionSettings": {
"minBalance": 1000,
"dormantPeriod": 0,
"allowAccountGoDormant": false
},
"productTenure": {},
"productAccounting": {
"feeIncome": "",
"taxesPayable": "",
"savingsControl": "5056806598",
"interestExpense": "1014973771",
"interestPayable": "5056806598",
"transactionSource": "4043554117"
},
"branch": [
"all_branches"
],
"isActive": true,
"status": "active",
"created_at": "2024-03-08T09:07:35.695Z",
"updated_at": "2024-03-13T08:49:00.960Z",
"depositProductFees": [
{
"id": "62847dc7-b840-49dd-b0a0-b265e0f69a3f",
"depositProductId": "cc795c3d-1eb1-4099-b46f-0f25e121bd74",
"fees": [
{
"value": 75,
"feeName": "deposit fee",
"feeType": "auto_per_all_deposit_transactions",
"feePayment": "FLAT"
}
],
"created_at": "2024-03-08T09:07:35.695Z",
"updated_at": "2024-03-13T08:49:00.960Z"
}
]
},
"maturityDate": null,
"dormantDate": null,
"id": "97706735-54d3-4f24-ab53-a5a92e17d931",
"accountBalance": 0,
"accountLedgerBalance": 0,
"accruedInterest": 0,
"created_at": "2024-04-02T09:27:27.960Z",
"updated_at": "2024-04-02T09:27:27.960Z"
}
} {
"depositProductId": "cc795c3d-1eb1-4099-b46f-0f25e121bd74",
"accountName": "testing",
"accountHolder": "d4c9f36f-ffbb-4c85-87cb-97c8fee6b9ad",
"accountHolderType": "clients",
"depositTenure": "24",
"depositInterestRate": 0,
"status": "active"
}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
{
"newAccountNumber": "0000000098"
}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
{
"newAccountNumber": "0000002777"
}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
{
"responseCode": "00",
"status": "success",
"message": "operation successful"
}{
"responseCode": "00",
"status": "success",
"message": "operation successful"
}Last updated
Was this helpful?