Deposit
Deposit model
Deposit model contains all the information about deposit placements.
Properties
- Name
_id
- Type
- objectId
- Description
Unique identifier.
- Name
date
- Type
- timestamp
- Description
Timestamp when deposit placement was made.
- Is Required
- Name
bilyetNumber
- Type
- string
- Description
Bilyet Number for deposit.
- Is Required
- Name
number
- Type
- string
- Description
Deposit number.
- Auto Generated (DP/MM/YYYY/XXX)
- Name
bank_id
- Type
- objectId
- Description
Bank identifier from master bank.
- Is Required
- Name
account
- Type
- object
- Description
Account from the bank.
- Is Required
- Name
account.number
- Type
- number
- Description
The account number from the bank account.
- Is Required
- Name
account.name
- Type
- string
- Description
The account name for the bank account.
- Is Required
- Name
owner_id
- Type
- objectId
- Description
Owner identifier from master owner.
- Is Required
- Name
baseDate
- Type
- number
- Description
Deposit base date (in days).
- Is Required
- Name
tenor
- Type
- number
- Description
Deposit tenor.
- Is Required
- Name
dueDate
- Type
- timestamp
- Description
Deposit due date.
- placementDate + tenor
- Name
isRollOver
- Type
- boolean
- Description
Is the deposit interest roll over or not.
- Name
amount
- Type
- number
- Description
Deposit placement amount.
- Is Required
- Name
remaining
- Type
- number
- Description
Deposit placement remaining.
- Name
sourceBank_id
- Type
- objectId
- Description
Source of fund bank identifier from master bank.
- Is Required
- Name
sourceAccount
- Type
- object
- Description
Source of fund account from the bank.
- Is Required
- Name
sourceAccount.number
- Type
- number
- Description
Source of fund account number from the bank account.
- Is Required
- Name
sourceAccount.name
- Type
- string
- Description
Source of fund account name for the bank account.
- Is Required
- Name
recipientBank_id
- Type
- objectId
- Description
Interest recipient bank identifier from master bank.
- Is Required
- Name
recipientAccount
- Type
- object
- Description
Interest recipient account from the bank.
- Is Required
- Name
recipientAccount.number
- Type
- number
- Description
The interest recipient account number from the bank account.
- Is Required
- Name
recipientAccount.name
- Type
- string
- Description
The interest recipient account name for the bank account.
- Is Required
- Name
paymentMethod
- Type
- enum
- Description
Deposit payment method.
- enum ['advance', 'in_arrear']
- Name
interestRate
- Type
- number
- Description
Deposit interest rate.
- Percentage
- Is Required
- Name
grossInterest
- Type
- number
- Description
Deposit gross interest amount.
- placementAmount * interestRate
- Name
taxRate
- Type
- number
- Description
Deposit tax rate.
- Percentage
- Is Required
- Name
taxAmount
- Type
- number
- Description
Deposit tax amount.
- interestAmount * taxRate
- Name
netInterest
- Type
- number
- Description
Deposit net interest amount.
- grossInterest - taxAmount
- Name
interests
- Type
- array
- Description
Interest information for deposit.
- Name
interests.$.baseDays
- Type
- number
- Description
Deposit interest base day.
- Is Required
- Name
interests.$.dueDate
- Type
- timestamp
- Description
Deposit interest due date.
- Name
interests.$.gross
- Type
- number
- Description
Deposit gross interest amount.
- Name
interests.$.taxAmount
- Type
- number
- Description
Deposit interest tax amount.
- Name
interests.$.net
- Type
- number
- Description
Deposit interest net interest amount.
- Name
isCashback
- Type
- boolean
- Description
Deposit cashback availability.
- Name
cashbacks
- Type
- array
- Description
Cashback information for deposit.
- Name
cashbacks.$.rate
- Type
- number
- Description
Deposit cashback rate.
- Name
cashbacks.$.amount
- Type
- number
- Description
Deposit cashback amount.
- Name
note
- Type
- string
- Description
Deposit note.
- Name
createdBy_id
- Type
- objectId
- Description
User identifier who create the deposit placement.
- Name
createdAt
- Type
- timestamp
- Description
Timestamp of when the deposit was created.
- Name
updatedBy_id
- Type
- objectId
- Description
User identifier who update the deposit placement.
- Name
updatedAt
- Type
- timestamp
- Description
Timestamp of when the deposit was updated.
- Name
deletedBy_id
- Type
- objectId
- Description
User identifier who deleted the deposit placement.
- Name
deletedAt
- Type
- timestamp
- Description
Timestamp of when the deposit was deleted.
- Name
deletedReason
- Type
- string
- Description
Deposit delete reason.
- Name
renewalDeposit_id
- Type
- objectId
- Description
Identifier from parent deposit.
- Name
cashbackPayments
- Type
- array
- Description
Deposit cashback payment array.
- Name
cashbackPayments.$._id
- Type
- object
- Description
Unique identifier for cashback payment.
- Name
cashbackPayments.$.rate
- Type
- objectId
- Description
Cashback payment date.
- Name
cashbackPayments.$.date
- Type
- objectId
- Description
Cashback payment date.
- Name
cashbackPayments.$.amount
- Type
- objectId
- Description
Cashback payment amount.
- Name
cashbackPayments.$.note
- Type
- string
- Description
Note of the cashback payment.
- Name
cashbackPayments.$.createdBy_id
- Type
- objectId
- Description
User identifier who create cashback payment.
- Name
cashbackPayments.$.createdAt
- Type
- timestamp
- Description
Timestamp of when cashback payment was created.
- Name
interestPayments
- Type
- array
- Description
Deposit interest payment array.
- Name
interestPayments.$._id
- Type
- objectId
- Description
Unique identifier for interest payment.
- Name
interestPayments.$.baseDays
- Type
- number
- Description
Interest payment base days.
- Name
interestPayments.$.date
- Type
- objectId
- Description
Interest payment date.
- Name
interestPayments.$.amount
- Type
- objectId
- Description
Interest payment amount.
- Name
interestPayments.$.recipientBank_id
- Type
- objectId
- Description
Interest recipient bank identifier from master bank.
- Is Required
- Name
interestPayments.$.recipientAccount
- Type
- object
- Description
Interest recipient account from the bank.
- Is Required
- Name
interestPayments.$.recipientAccount.number
- Type
- number
- Description
The interest recipient account number from the bank account.
- Is Required
- Name
interestPayments.$.recipientAccount.name
- Type
- string
- Description
The interest recipient account name for the bank account.
- Is Required
- Name
interestPayments.$.note
- Type
- string
- Description
Note of the cashback payment.
- Name
interestPayments.$.createdBy_id
- Type
- objectId
- Description
User identifier who create interest payment.
- Name
interestPayments.$.createdAt
- Type
- timestamp
- Description
Timestamp of when interest payment was created.
- Name
withdrawalPayments
- Type
- array
- Description
Deposit withdrawal payment array.
- Name
withdrawalPayments.$._id
- Type
- objectId
- Description
Unique identifier for withdrawal payment.
- Name
withdrawalPayments.$.date
- Type
- objectId
- Description
Withdrawal payment date.
- Name
withdrawalPayments.$.amount
- Type
- objectId
- Description
Withdrawal payment amount.
- Name
withdrawalPayments.$.recipientBank_id
- Type
- objectId
- Description
Withdrawal recipient bank identifier from master bank.
- Is Required
- Name
withdrawalPayments.$.recipientAccount
- Type
- object
- Description
Withdrawal recipient account from the bank.
- Is Required
- Name
withdrawalPayments.$.recipientAccount.number
- Type
- number
- Description
The withdrawal recipient account number from the bank account.
- Is Required
- Name
withdrawalPayments.$.recipientAccount.name
- Type
- string
- Description
The withdrawal recipient account name for the bank account.
- Is Required
- Name
withdrawalPayments.$.note
- Type
- string
- Description
Note of the withdrawal payment.
- Name
withdrawalPayments.$.createdBy_id
- Type
- objectId
- Description
User identifier who create withdrawal payment.
- Name
withdrawalPayments.$.createdAt
- Type
- timestamp
- Description
Timestamp of when withdrawal payment was created.
List all deposit
This endpoint allows you to retrieve a paginated list of all your deposit.
Request
Optional query
- Name
page
- Type
- integer
- Description
The page number of deposit returned.
- Default
1
- Default
- Name
pageSize
- Type
- integer
- Description
The page size number of deposit returned.
- Default
10
- Default
- Name
search
- Type
- object
- Description
Filter data by text.
- Name
sort
- Type
- object
- Description
asc
sort ascendingdesc
sort descending
Request
const response = axios.get('/v1/deposits', {
"params": {
"page": 1,
"page_size": 10
}
})
Response
{
"data": [
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z"
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"pageCount": 1,
"totalDocument": 2
}
}
Create deposit
This endpoint allows you to add new deposit placement.
Request
Required attributes
- Name
date
- Type
- timestamp
- Description
Timestamp when deposit placement was made.
- Name
bilyetNumber
- Type
- string
- Description
Bilyet Number for deposit.
- Name
bank_id
- Type
- objectId
- Description
Bank identifier from master bank.
- Name
account
- Type
- object
- Description
Account from the bank.
- Name
account.number
- Type
- number
- Description
The account number from the bank account.
- Name
account.name
- Type
- string
- Description
The account name for the bank account.
- Name
owner_id
- Type
- objectId
- Description
Owner identifier from master owner.
- Name
baseDate
- Type
- number
- Description
Deposit base date (in days).
- Name
tenor
- Type
- number
- Description
Deposit tenor.
- Name
isRollOver
- Type
- boolean
- Description
Is the deposit interest roll over or not.
- Name
amount
- Type
- number
- Description
Deposit placement amount.
- Name
sourceBank_id
- Type
- objectId
- Description
Source of fund bank identifier from master bank.
- Name
sourceAccount
- Type
- object
- Description
Source of fund account from the bank.
- Name
sourceAccount.number
- Type
- number
- Description
Source of fund account number from the bank account.
- Name
sourceAccount.name
- Type
- string
- Description
Source of fund account name for the bank account.
- Name
recipientBank_id
- Type
- objectId
- Description
Interest recipient bank identifier from master bank.
- Name
recipientAccount
- Type
- object
- Description
Interest recipient account from the bank.
- Name
recipientAccount.number
- Type
- number
- Description
The interest recipient account number from the bank account.
- Name
recipientAccount.name
- Type
- string
- Description
The interest recipient account name for the bank account.
- Name
paymentMethod
- Type
- enum ['advance', 'in_arrear']
- Description
Deposit payment method.
- Name
interestRate
- Type
- number
- Description
Deposit interest rate.
- Name
taxRate
- Type
- number
- Description
Deposit tax rate.
- Name
returns
- Type
- array
- Description
Return information for deposit.
- Name
returns.$.baseDays
- Type
- number
- Description
Deposit return base day.
- Name
isCashback
- Type
- boolean
- Description
Deposit cashback availability.
- Name
cashbacks
- Type
- array
- Description
Cashback information for deposit.
- Name
cashbacks.$.rate
- Type
- number
- Description
Deposit cashback rate.
- Name
note
- Type
- string
- Description
Deposit note.
Request
const response = axios.post('/v1/deposits',
{
"date": "2024-03-24",
"bilyetNumber": "BILYET001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"taxRate": 20,
"returns": [
{
"baseDays": 30
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5
}
],
"note": "this is note"
})
Response
{
"data": [
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z"
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"pageCount": 1,
"totalDocument": 2
}
}
Retrieve deposit
This endpoint allows you to retrieve a deposit placement by id.
Request
const response = axios.get('/v1/deposits/637b569149e0c02e1036c35a')
Response
{
"data": [
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z"
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"pageCount": 1,
"totalDocument": 2
}
}
Update deposit
This endpoint allows you to perform an update on a deposit placement.
Request
Optional attributes
- Name
date
- Type
- timestamp
- Description
Timestamp when deposit placement was made.
- Name
bilyetNumber
- Type
- string
- Description
Bilyet Number for deposit.
- Name
bank_id
- Type
- objectId
- Description
Bank identifier from master bank.
- Name
account
- Type
- object
- Description
Account from the bank.
- Name
account.number
- Type
- number
- Description
The account number from the bank account.
- Name
account.name
- Type
- string
- Description
The account name for the bank account.
- Name
owner_id
- Type
- objectId
- Description
Owner identifier from master owner.
- Name
baseDate
- Type
- number
- Description
Deposit base date (in days).
- Name
tenor
- Type
- number
- Description
Deposit tenor.
- Name
isRollOver
- Type
- boolean
- Description
Is the deposit interest roll over or not.
- Name
amount
- Type
- number
- Description
Deposit placement amount.
- Name
sourceBank_id
- Type
- objectId
- Description
Source of fund bank identifier from master bank.
- Name
sourceAccount
- Type
- object
- Description
Source of fund account from the bank.
- Name
sourceAccount.number
- Type
- number
- Description
Source of fund account number from the bank account.
- Name
sourceAccount.name
- Type
- string
- Description
Source of fund account name for the bank account.
- Name
recipientBank_id
- Type
- objectId
- Description
Interest recipient bank identifier from master bank.
- Name
recipientAccount
- Type
- object
- Description
Interest recipient account from the bank.
- Name
recipientAccount.number
- Type
- number
- Description
The interest recipient account number from the bank account.
- Name
recipientAccount.name
- Type
- string
- Description
The interest recipient account name for the bank account.
- Name
paymentMethod
- Type
- enum ['advance', 'in_arrear']
- Description
Deposit payment method.
- Name
interestRate
- Type
- number
- Description
Deposit interest rate.
- Name
taxRate
- Type
- number
- Description
Deposit tax rate.
- Name
returns
- Type
- array
- Description
Return information for deposit.
- Name
returns.$.baseDays
- Type
- number
- Description
Deposit return base day.
- Name
isCashback
- Type
- boolean
- Description
Deposit cashback availability.
- Name
cashbacks
- Type
- array
- Description
Cashback information for deposit.
- Name
cashbacks.$.rate
- Type
- number
- Description
Deposit cashback rate.
- Name
note
- Type
- string
- Description
Deposit note.
Request
const response = axios.patch('/v1/deposits/637b569149e0c02e1036c35a',
{
"date": "2024-03-24",
"bilyetNumber": "BILYET001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"taxRate": 20,
"returns": [
{
"baseDays": 30
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5
}
],
"note": "this is note"
})
Response
{
"data": [
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"updatedBy_id": "637d83d15d2be122007524bf",
"updatedAt": "2022-01-01T00:00:00.000Z"
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"pageCount": 1,
"totalDocument": 2
}
}
Delete deposit
This endpoint allows you to retrieve a deposit placement by id.
Request
Required attributes
- Name
deletedReason
- Type
- string
- Description
Delete reason.
Request
const response = axios.delete('/v1/deposits/637b569149e0c02e1036c35a?deletedReason=this is reason')
Response
// empty response
Create deposit cashback
This endpoint allows you to add new deposit cashback.
Request
Required attributes
- Name
payments
- Type
- array
- Description
Cashback payments.
- Name
payments.$.date
- Type
- timestamp
- Description
Cashback payment date.
- Name
payments.$.received
- Type
- boolean
- Description
Cashback payment amount.
- Name
payments.$.note
- Type
- string
- Description
Payment note.
Request
const response = axios.post('/v1/deposit/637b569149e0c02e1036c35a/cashbacks', {
"payments": [
{
"date": "2024-04-20T00:00:00.000Z",
"received": 200000,
"note": "this is note"
}
]
})
Response
{
"data": [
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328,
"remaining": 230328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"cashbackPayments": [
{
"_id": "62502423f4c98d001fa952a1",
"date": "2024-04-20T00:00:00.000Z",
"received": 200000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
]
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"pageCount": 1,
"totalDocument": 1
}
}
Update deposit cashback
This endpoint allows you to perform an update on a deposit cashback.
Request
Optional attributes
- Name
date
- Type
- timestamp
- Description
Cashback payment date.
- Name
received
- Type
- boolean
- Description
Cashback payment amount.
- Name
note
- Type
- string
- Description
Payment note.
Request
const response = axios.post('/v1/deposit/637b569149e0c02e1036c35a/cashbacks/62502423f4c98d001fa952a1', {
"date": "2024-04-20T00:00:00.000Z",
"received": 300000,
"note": "this is note"
})
Response
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328,
"remaining": 130328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"cashbackPayments": [
{
"_id": "62502423f4c98d001fa952a1",
"date": "2024-04-20T00:00:00.000Z",
"received": 300000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"updatedBy_id": "637d83d15d2be122007524bf",
"updatedAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
]
}
Delete deposit cashback
This endpoint allows you to delete deposit cashback by id.
Request
Required attributes
- Name
deletedReason
- Type
- string
- Description
Delete reason.
Request
const response = axios.delete('/v1/deposit/637b569149e0c02e1036c35a/cashbacks/62502423f4c98d001fa952a1?deletedReason=this is reason')
Response
// empty response
Create deposit interest
This endpoint allows you to add new deposit interest.
Request
Required attributes
- Name
payments
- Type
- array
- Description
Interest payments.
- Name
payments.$.baseDays
- Type
- number
- Description
Interest baseDays.
- Name
payments.$.recipientBank_id
- Type
- objectId
- Description
Interest recipient bank identifier from master bank.
- Name
payments.$.recipientAccount
- Type
- object
- Description
Interest recipient account from the bank.
- Name
payments.$.recipientAccount.number
- Type
- number
- Description
The interest recipient account number from the bank account.
- Name
payments.$.recipientAccount.name
- Type
- string
- Description
The interest recipient account name for the bank account.
- Name
payments.$.date
- Type
- timestamp
- Description
Interest payment date.
- Name
payments.$.received
- Type
- number
- Description
Interest payment amount.
- Name
payments.$.note
- Type
- string
- Description
Interest note.
Request
const response = axios.post('/v1/deposits/637b569149e0c02e1036c35a/interest', {
"payments": [
{
"baseDays": 30,
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 344262,
"note": "this is note"
}
]
})
Response
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262,
"remaining": 0
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328,
"remaining": 130328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"cashbackPayments": [
{
"_id": "62502423f4c98d001fa952a1",
"date": "2024-04-20T00:00:00.000Z",
"received": 300000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"interestPayments": [
{
"_id": "62502423f4c98d001fa952a2",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 344262,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
]
}
Update deposit interest
This endpoint allows you to perform an update on a deposit interest.
Request
Optional attributes
- Name
baseDays
- Type
- number
- Description
Interest baseDays.
- Name
recipientBank_id
- Type
- objectId
- Description
Interest recipient bank identifier from master bank.
- Name
recipientAccount
- Type
- object
- Description
Interest recipient account from the bank.
- Name
recipientAccount.number
- Type
- number
- Description
The interest recipient account number from the bank account.
- Name
recipientAccount.name
- Type
- string
- Description
The interest recipient account name for the bank account.
- Name
date
- Type
- timestamp
- Description
Interest payment date.
- Name
received
- Type
- number
- Description
Interest payment amount.
- Name
note
- Type
- string
- Description
Interest note.
Request
const response = axios.patch('/v1/deposit/637b569149e0c02e1036c35a/interest/62502423f4c98d001fa952a2',
{
"baseDays": 30,
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 344262,
"note": "this is note"
})
Response
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 150000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262,
"remaining": 100000
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328,
"remaining": 130328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"cashbackPayments": [
{
"_id": "62502423f4c98d001fa952a1",
"date": "2024-04-20T00:00:00.000Z",
"received": 300000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"interestPayments": [
{
"_id": "62502423f4c98d001fa952a2",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 244262,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
]
}
Delete deposit interest
This endpoint allows you to retrieve a deposit interest by id.
Request
Required attributes
- Name
deletedReason
- Type
- string
- Description
Delete reason.
Request
const response = axios.delete('/v1/deposit/637b569149e0c02e1036c35a/interest/62502423f4c98d001fa952a2?deletedReason=this is reason')
Response
// empty response
Create deposit withdrawal
This endpoint allows you to add new deposit withdrawal.
Request
Required attributes
- Name
payments
- Type
- array
- Description
Withdrawal payments.
- Name
payments.$.recipientBank_id
- Type
- objectId
- Description
Withdrawal recipient bank identifier from master bank.
- Name
payments.$.recipientAccount
- Type
- object
- Description
Withdrawal recipient account from the bank.
- Name
payments.$.recipientAccount.number
- Type
- number
- Description
The withdrawal recipient account number from the bank account.
- Name
payments.$.recipientAccount.name
- Type
- string
- Description
The withdrawal recipient account name for the bank account.
- Name
payments.$.date
- Type
- timestamp
- Description
Withdrawal payment date.
- Name
payments.$.received
- Type
- number
- Description
Withdrawal payment amount.
- Name
payments.$.note
- Type
- string
- Description
Withdrawal note.
Request
const response = axios.post('/v1/deposit-interest', {
"payments": [
{
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 50000000,
"note": "this is note"
}
]
})
Response
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 100000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262,
"remaining": 0
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328,
"remaining": 130328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"cashbackPayments": [
{
"_id": "62502423f4c98d001fa952a1",
"date": "2024-04-20T00:00:00.000Z",
"received": 300000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"interestPayments": [
{
"_id": "62502423f4c98d001fa952a2",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 344262,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"withdrawalPayments": [
{
"_id": "62502423f4c98d001fa952a3",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 50000000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
]
}
Update deposit withdrawal
This endpoint allows you to perform an update on a deposit withdrawal.
Request
Optional attributes
- Name
recipientBank_id
- Type
- objectId
- Description
Withdrawal recipient bank identifier from master bank.
- Name
recipientAccount
- Type
- object
- Description
Withdrawal recipient account from the bank.
- Name
recipientAccount.number
- Type
- number
- Description
The withdrawal recipient account number from the bank account.
- Name
recipientAccount.name
- Type
- string
- Description
The withdrawal recipient account name for the bank account.
- Name
date
- Type
- timestamp
- Description
Withdrawal payment date.
- Name
received
- Type
- number
- Description
Withdrawal payment amount.
- Name
note
- Type
- string
- Description
Withdrawal note.
Request
const response = axios.patch('/v1/deposits/637b569149e0c02e1036c35a/withdrawals/62502423f4c98d001fa952a3',
{
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 75000000,
"note": "this is note"
})
Response
{
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 75000000,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262,
"remaining": 0
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328,
"remaining": 130328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"cashbackPayments": [
{
"_id": "62502423f4c98d001fa952a1",
"date": "2024-04-20T00:00:00.000Z",
"received": 300000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"interestPayments": [
{
"_id": "62502423f4c98d001fa952a2",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 344262,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"withdrawalPayments": [
{
"_id": "62502423f4c98d001fa952a3",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 75000000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
]
}
Delete deposit withdrawal
This endpoint allows you to delete a deposit withdrawal by id.
Request
Required attributes
- Name
deletedReason
- Type
- string
- Description
Delete reason.
Request
const response = axios.delete('/v1/deposits/637b569149e0c02e1036c35a/withdrawals/62502423f4c98d001fa952a3?deletedReason=this is reason')
Response
// empty response
Create deposit renewal
This endpoint allows you to add new deposit renewal.
Request
Required attributes
- Name
date
- Type
- timestamp
- Description
Timestamp when deposit renewal was made.
- Name
baseDate
- Type
- number
- Description
Renewal base date (in days).
- Name
tenor
- Type
- number
- Description
Renewal tenor.
- Name
dueDate
- Type
- timestamp
- Description
Renewal due date.
- Name
isRollOver
- Type
- boolean
- Description
Is the renewal interest roll over or not.
- Name
amount
- Type
- number
- Description
Renewal amount.
- Name
paymentMethod
- Type
- enum
- Description
Renewal payment method.
- Name
interestRate
- Type
- number
- Description
Renewal interest rate.
- Name
taxRate
- Type
- number
- Description
Renewal tax rate.
- Name
returns
- Type
- array
- Description
Return information for renewal.
- Name
returns.$.baseDays
- Type
- number
- Description
Renewal return base day.
- Name
isCashback
- Type
- boolean
- Description
Renewal cashback availability.
- Name
cashbacks
- Type
- array
- Description
Cashback information for renewal.
- Name
cashbacks.$.rate
- Type
- number
- Description
Renewal cashback rate.
- Name
note
- Type
- string
- Description
Renewal note.
Request
const response = axios.post('/v1/deposits/637b569149e0c02e1036c35a/renewal', {
"date": "2024-03-24",
"baseDate": 366,
"tenor": 90,
"isRollOver": true,
"amount": 75000000,
"paymentMethod": "advance",
"interestRate": 3.5,
"taxRate": 20,
"returns": [
{
"baseDays": 30
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5
}
],
"note": "this is note",
})
Response
{
"_id": "623fd8117b8b43065f5d108e",
"deposit": {
"_id": "637b569149e0c02e1036c35a",
"date": "2024-03-24T00:00:00.000Z",
"bilyetNumber": "BILYET001",
"number": "DP/03/2024/001",
"bank_id": "623fd4c6060a3208d98e3a4c",
"account": {
"number": "86401234",
"name": "John"
},
"owner_id": "623fd5d8b5dfb53e27c0f3a2",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"remaining": 0,
"sourceBank_id": "623fd4c6060a3208d98e3a4c",
"sourceAccount": {
"number": "86401234",
"name": "John"
},
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"gross": 430328,
"taxAmount": 86066,
"net": 344262,
"remaining": 0
}
],
"isCashback": true,
"cashbacks": [
{
"rate": 5,
"amount": 430328,
"remaining": 130328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"cashbackPayments": [
{
"_id": "62502423f4c98d001fa952a1",
"date": "2024-04-20T00:00:00.000Z",
"received": 300000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"interestPayments": [
{
"_id": "62502423f4c98d001fa952a2",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 344262,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
],
"withdrawalPayments": [
{
"_id": "62502423f4c98d001fa952a3",
"recipientBank_id": "623fd4c6060a3208d98e3a4c",
"recipientAccount": {
"number": "86701235",
"name": "Doe"
},
"date": "2024-04-20T00:00:00.000Z",
"received": 75000000,
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"status": "complete"
}
]
},
"number": "DP/03/2024/002",
"date": "2024-03-24T00:00:00.000Z",
"baseDate": 366,
"tenor": 90,
"dueDate": "2025-03-24T00:00:00.000Z",
"isRollOver": true,
"amount": 150000000,
"paymentMethod": "advance",
"interestRate": 3.5,
"grossInterest": 1290984,
"taxRate": 20,
"taxAmount": 258197,
"netInterest": 1032787,
"returns": [
{
"_id": "623fd7a774fc59459af68337",
"baseDays": 30,
"dueDate": "2024-04-24T00:00:00.000Z",
"grossInterest": 430328,
"taxAmount": 86066,
"netInterest": 344262
}
],
"isCashback": true,
"cashbacks": [
{
"_id": "623fd7dd33a91a2f3d4b57fb",
"rate": 5,
"amount": 430328
}
],
"note": "this is note",
"createdBy_id": "637d83d15d2be122007524bf",
"createdAt": "2022-01-01T00:00:00.000Z",
"renewalDeposit_id": "637b569149e0c02e1036c35a"
}