Deposits

Get all deposits

Get all deposits

GET {base url}/v1/deposits

Get all deposits

Query Parameters

Name	Type	Description
page	number
perPage	number

200: OK Deposits fetched successfully

{
  "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
  }
}

403: Forbidden Unauthorised

Get deposit details

Get deposit details

GET {base url}/v1/deposits/_single

Get single deposit details

Query Parameters

Name	Type	Description
depositId*	string

200: OK Deposit detail fetched successfully

403: Forbidden Unauthorised

Get deposit account balances

Get deposit account balances

GET {base url}/v1/deposits/{depositId}/balances

Get deposit account balances

200: OK Deposit account balances fetched successfully

{
    "responseCode": "00",
    "status": "success",
    "message": "Deposits balances fetch successful",
    "data": {
        "ledger balance": 8500,
        "available balance": 8500
    }
}

403: Forbidden Unauthorised

Get deposit transactions

Get deposit transactions

GET {base url}/v1/deposits/transactions

Get all deposit transactions

Query Parameters

Name	Type	Description
accountNumber*	string

200: OK deposit transactions fetched successfully

{
    "status": "success",
    "message": "Transactions fetched successfully",
    "data": [],
    "pagination": {
        "currentPage": 1,
        "perPage": 15,
        "totalCount": 0,
        "totalPages": 0,
        "previousPage": 0,
        "nextPage": 0
    }
}

403: Forbidden Unauthorised

Add deposits

Add new deposit

POST {base url}/v1/deposits/transactions

Add new deposit

Request Body

Name	Type	Description
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

201: Created Deposit added successfully

{
    "responseCode": "00",
    "message": "deposit added successfully"
}

403: Forbidden Unauthorised

Deposit withdrawal

Deposit withdrawal

POST {base url}/v1/deposits/transactions

Deposit withdrawal

Request Body

Name	Type	Description
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

200: OK Deposit withdrawal successful

{
    "responseCode": "00",
    "message": "deposit withdrawal successful"
}

403: Forbidden Unauthorised

Deposit transfer

Deposit transfer

POST {base url}/v1/deposits/transactions/transfer

Deposit transfer

Request Body

Name	Type	Description
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

200: OK Deposit transfer successful

{
    "responseCode": "00",
    "message": "deposit transfer successful"
}

403: Forbidden Unauthorised

create deposit

Create deposit

POST {base url}/v1/deposits

create deposit

Headers

Name	Type	Description
Authorization header*	String	API user secret key

Body

Name	Type	Description
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

200: OK Deposit created successfully

{
    "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"
    }
}

400: Unauthorised

Sample request

   { 
    "depositProductId": "cc795c3d-1eb1-4099-b46f-0f25e121bd74",
    "accountName": "testing",
    "accountHolder": "d4c9f36f-ffbb-4c85-87cb-97c8fee6b9ad",
    "accountHolderType": "clients",
    "depositTenure": "24",
    "depositInterestRate": 0,
    "status": "active"
}

Sample response

Pre liquidate account

Pre liquidate account

POST {base url}/v1/deposits/{depositId}/pre_liquidate

pre liquidate account

Headers

Name	Type	Description
Authorization header*	String	API user secret key

Body

Name	Type	Description
newAccountNumber *	string	new account number

Response

200

400: unauthorised

Sample request

{
    "newAccountNumber": "0000000098"
}

Sample response

liquidate account

Liquidate account

POST {base url}/v1/deposits/{depositId}/liquidate

Liquidate account

Headers

Name	Type	Description
Authorization header*	String	API user secret key

Body

Name	Type	Description
newAccountNumber *	string	new account number

Response

200

400: unauthorised

Sample request

{
    "newAccountNumber": "0000002777"
}

Sample response

apply accrued interest

Apply accrued interest

POST {base url}/v1/deposits/{accountNumber}/apply_interest

apply accrued interest

Headers

Name	Type	Description
Authorization header*	String	API user secret key

Response

200: OK operation successful

{
    "responseCode": "00",
    "status": "success",
    "message": "operation successful"
}

400: unauthorised

Sample response

{
    "responseCode": "00",
    "status": "success",
    "message": "operation successful"
}