Search

/

Reference

Pages

Homeorganizationproductsdeposit accountsloan accountstransactionsservicesledgersuserssystem

Deposit Accounts

This page includes documentation on managing deposit accounts and resources associated with it such as cards, fund blocks and interests.

DEPOSITS

Package deposits.

CreateAccount

POST /v1/accounts/deposits

Creates a new deposit account..

Request Body (Account)
Name Description Type
account_id The ID of the account String
name The name of the account String
notes Extra notes on the account String
holder_id The ID of the entity that holds the account String
holder_type The type of the entity that holds the account Entity
state The state of the account AccountState
type The type of the deposit account AccountType
accrued_amounts Details related to a deposit account's accrued amounts AccruedAmounts
assigned_branch_id The ID of the branch the account is assigned to String
assigned_centre_id The ID of the centre the account is assigned to String
assigned_user_id The ID of the user the account is assigned to String
balances The account's balances Balances
revolving_account_id The ID of the revolving account the account is register to String
currency_code The currency code of the account String
interest_settings The account's interest settings DepositInterestSettings
internal_controls Internal controls related to the account InternalControls
settlement_account_ids The IDs of the list of settlement accounts the account is linked to Array[String]
migration_event_id The ID of the migration event the account is imported from String
overdraft_rate_settings The account's overdraft interest rate settings OverdraftRateSettings
overdraft_settings The account's overdraft settings OverdraftSettings
product_id The ID of the product the account is created from String
withholding_tax_source_id The ID of the withholding tax source String
create_time The time the account was created Timestamp
approve_time The time the account was approved Timestamp
activate_time The time the account was activated Timestamp
update_time The time the account was last updated Timestamp
close_time The time the account was closed Timestamp
appraise_time The time the account was last evaluated for interest calculations/maturity Timestamp
interest_calculate_time The time the account last had its interest calculated Timestamp
interest_store_time The time the account last had its interest applied (stored to balance) Timestamp
overdraft_interest_review_time The time the account was last reviewed for overdraft interest Timestamp
arrears_set_time The time the account was set to In Arrears state, or null if the account is not In Arrears state Timestamp
lock_time The time the account was locked Timestamp
mature_time The time the account matures for fixed or compulsory savings plans Timestamp
  • Name Description Type
    account_id The ID of the account String
    name The name of the account String
    notes Extra notes on the account String
    holder_id The ID of the entity that holds the account String
    holder_type The type of the entity that holds the account Entity
    state The state of the account AccountState
    type The type of the deposit account AccountType
    accrued_amounts Details related to a deposit account's accrued amounts AccruedAmounts
    assigned_branch_id The ID of the branch the account is assigned to String
    assigned_centre_id The ID of the centre the account is assigned to String
    assigned_user_id The ID of the user the account is assigned to String
    balances The account's balances Balances
    revolving_account_id The ID of the revolving account the account is register to String
    currency_code The currency code of the account String
    interest_settings The account's interest settings DepositInterestSettings
    internal_controls Internal controls related to the account InternalControls
    settlement_account_ids The IDs of the list of settlement accounts the account is linked to Array[String]
    migration_event_id The ID of the migration event the account is imported from String
    overdraft_rate_settings The account's overdraft interest rate settings OverdraftRateSettings
    overdraft_settings The account's overdraft settings OverdraftSettings
    product_id The ID of the product the account is created from String
    withholding_tax_source_id The ID of the withholding tax source String
    create_time The time the account was created Timestamp
    approve_time The time the account was approved Timestamp
    activate_time The time the account was activated Timestamp
    update_time The time the account was last updated Timestamp
    close_time The time the account was closed Timestamp
    appraise_time The time the account was last evaluated for interest calculations/maturity Timestamp
    interest_calculate_time The time the account last had its interest calculated Timestamp
    interest_store_time The time the account last had its interest applied (stored to balance) Timestamp
    overdraft_interest_review_time The time the account was last reviewed for overdraft interest Timestamp
    arrears_set_time The time the account was set to In Arrears state, or null if the account is not In Arrears state Timestamp
    lock_time The time the account was locked Timestamp
    mature_time The time the account matures for fixed or compulsory savings plans Timestamp

ListAccounts

GET /v1/accounts/deposits

Lists a list of deposit accounts..

Parameters
Name Description Type
Query Parameters
page_token The page token of the page to retrieve String
page_size The number of accounts to retrieve per page Integer
order_by The field to order the results by String
filter The filter to apply to the list String
  • Name Description Type
    total The total number of accounts matching the filter Integer
    remaining The number of accounts remaining in the list, including the accounts in the response Integer
    accounts The list of deposit accounts retrieved Array[Account]
    next_page_token The page token of the next page of results String

GetAccount

GET /v1/accounts/deposits/{AccountID}

Retrieves a specified deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to retrieve String
  • Name Description Type
    account_id The ID of the account String
    name The name of the account String
    notes Extra notes on the account String
    holder_id The ID of the entity that holds the account String
    holder_type The type of the entity that holds the account Entity
    state The state of the account AccountState
    type The type of the deposit account AccountType
    accrued_amounts Details related to a deposit account's accrued amounts AccruedAmounts
    assigned_branch_id The ID of the branch the account is assigned to String
    assigned_centre_id The ID of the centre the account is assigned to String
    assigned_user_id The ID of the user the account is assigned to String
    balances The account's balances Balances
    revolving_account_id The ID of the revolving account the account is register to String
    currency_code The currency code of the account String
    interest_settings The account's interest settings DepositInterestSettings
    internal_controls Internal controls related to the account InternalControls
    settlement_account_ids The IDs of the list of settlement accounts the account is linked to Array[String]
    migration_event_id The ID of the migration event the account is imported from String
    overdraft_rate_settings The account's overdraft interest rate settings OverdraftRateSettings
    overdraft_settings The account's overdraft settings OverdraftSettings
    product_id The ID of the product the account is created from String
    withholding_tax_source_id The ID of the withholding tax source String
    create_time The time the account was created Timestamp
    approve_time The time the account was approved Timestamp
    activate_time The time the account was activated Timestamp
    update_time The time the account was last updated Timestamp
    close_time The time the account was closed Timestamp
    appraise_time The time the account was last evaluated for interest calculations/maturity Timestamp
    interest_calculate_time The time the account last had its interest calculated Timestamp
    interest_store_time The time the account last had its interest applied (stored to balance) Timestamp
    overdraft_interest_review_time The time the account was last reviewed for overdraft interest Timestamp
    arrears_set_time The time the account was set to In Arrears state, or null if the account is not In Arrears state Timestamp
    lock_time The time the account was locked Timestamp
    mature_time The time the account matures for fixed or compulsory savings plans Timestamp

UpdateAccount

PUT /v1/accounts/deposits/{AccountID}

Updates a deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to update String
Request Body (Account)
Name Description Type
account_id The ID of the account String
name The name of the account String
notes Extra notes on the account String
holder_id The ID of the entity that holds the account String
holder_type The type of the entity that holds the account Entity
state The state of the account AccountState
type The type of the deposit account AccountType
accrued_amounts Details related to a deposit account's accrued amounts AccruedAmounts
assigned_branch_id The ID of the branch the account is assigned to String
assigned_centre_id The ID of the centre the account is assigned to String
assigned_user_id The ID of the user the account is assigned to String
balances The account's balances Balances
revolving_account_id The ID of the revolving account the account is register to String
currency_code The currency code of the account String
interest_settings The account's interest settings DepositInterestSettings
internal_controls Internal controls related to the account InternalControls
settlement_account_ids The IDs of the list of settlement accounts the account is linked to Array[String]
migration_event_id The ID of the migration event the account is imported from String
overdraft_rate_settings The account's overdraft interest rate settings OverdraftRateSettings
overdraft_settings The account's overdraft settings OverdraftSettings
product_id The ID of the product the account is created from String
withholding_tax_source_id The ID of the withholding tax source String
create_time The time the account was created Timestamp
approve_time The time the account was approved Timestamp
activate_time The time the account was activated Timestamp
update_time The time the account was last updated Timestamp
close_time The time the account was closed Timestamp
appraise_time The time the account was last evaluated for interest calculations/maturity Timestamp
interest_calculate_time The time the account last had its interest calculated Timestamp
interest_store_time The time the account last had its interest applied (stored to balance) Timestamp
overdraft_interest_review_time The time the account was last reviewed for overdraft interest Timestamp
arrears_set_time The time the account was set to In Arrears state, or null if the account is not In Arrears state Timestamp
lock_time The time the account was locked Timestamp
mature_time The time the account matures for fixed or compulsory savings plans Timestamp
  • Name Description Type
    account_id The ID of the account String
    name The name of the account String
    notes Extra notes on the account String
    holder_id The ID of the entity that holds the account String
    holder_type The type of the entity that holds the account Entity
    state The state of the account AccountState
    type The type of the deposit account AccountType
    accrued_amounts Details related to a deposit account's accrued amounts AccruedAmounts
    assigned_branch_id The ID of the branch the account is assigned to String
    assigned_centre_id The ID of the centre the account is assigned to String
    assigned_user_id The ID of the user the account is assigned to String
    balances The account's balances Balances
    revolving_account_id The ID of the revolving account the account is register to String
    currency_code The currency code of the account String
    interest_settings The account's interest settings DepositInterestSettings
    internal_controls Internal controls related to the account InternalControls
    settlement_account_ids The IDs of the list of settlement accounts the account is linked to Array[String]
    migration_event_id The ID of the migration event the account is imported from String
    overdraft_rate_settings The account's overdraft interest rate settings OverdraftRateSettings
    overdraft_settings The account's overdraft settings OverdraftSettings
    product_id The ID of the product the account is created from String
    withholding_tax_source_id The ID of the withholding tax source String
    create_time The time the account was created Timestamp
    approve_time The time the account was approved Timestamp
    activate_time The time the account was activated Timestamp
    update_time The time the account was last updated Timestamp
    close_time The time the account was closed Timestamp
    appraise_time The time the account was last evaluated for interest calculations/maturity Timestamp
    interest_calculate_time The time the account last had its interest calculated Timestamp
    interest_store_time The time the account last had its interest applied (stored to balance) Timestamp
    overdraft_interest_review_time The time the account was last reviewed for overdraft interest Timestamp
    arrears_set_time The time the account was set to In Arrears state, or null if the account is not In Arrears state Timestamp
    lock_time The time the account was locked Timestamp
    mature_time The time the account matures for fixed or compulsory savings plans Timestamp

DeleteAccount

DELETE /v1/accounts/deposits/{AccountID}

Deletes the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to delete String

CreateFundBlock

POST /v1/accounts/deposits/{AccountID}/blocks

Creates a new block fund for the deposit acount..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to create the block fund for String
Request Body (FundBlock)
Name Description Type
block_id The ID of the fund block String
account_id The ID of the deposit account associated with the blocked funds String
amount The amount of funds that are blocked Amount
seized_amount The amount of the blocked funds that have been seized Amount
state The state of the block fund BlockState
notes Extra human-readable notes about the block fund String
create_time The time when the block fund was created Timestamp
update_time The time when the block fund was last updated Timestamp
  • Name Description Type
    block_id The ID of the fund block String
    account_id The ID of the deposit account associated with the blocked funds String
    amount The amount of funds that are blocked Amount
    seized_amount The amount of the blocked funds that have been seized Amount
    state The state of the block fund BlockState
    notes Extra human-readable notes about the block fund String
    create_time The time when the block fund was created Timestamp
    update_time The time when the block fund was last updated Timestamp

ListFundBlocks

GET /v1/accounts/deposits/{AccountID}/blocks

Lists the fund blocks for the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to list the block funds for String
page_token The page token of the page to retrieve String
page_size The number of fund blocks to retrieve per page Integer
order_by The field to order the results by String
filter The filter to apply to the list String
  • Name Description Type
    total The total number of blocks matching the filter Integer
    remaining The number of blocks remaining in the list, including the blocks in the response Integer
    blocks The list of fund blocks retrieved Array[FundBlock]
    next_page_token The page token of the next page of results String

GetFundBlock

GET /v1/accounts/deposits/{AccountID}/blocks/{BlockID}

Retrieves a specified fund block..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to retrieve block funds for String
block_id The ID of the fund block to retrieve String
  • Name Description Type
    block_id The ID of the fund block String
    account_id The ID of the deposit account associated with the blocked funds String
    amount The amount of funds that are blocked Amount
    seized_amount The amount of the blocked funds that have been seized Amount
    state The state of the block fund BlockState
    notes Extra human-readable notes about the block fund String
    create_time The time when the block fund was created Timestamp
    update_time The time when the block fund was last updated Timestamp

UpdateFundBlock

PUT /v1/accounts/deposits/{AccountID}/blocks/{BlockID}

Updates a fund block..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to update the fund block for String
block_id The ID of the fund block to update String
Request Body (FundBlock)
Name Description Type
block_id The ID of the fund block String
account_id The ID of the deposit account associated with the blocked funds String
amount The amount of funds that are blocked Amount
seized_amount The amount of the blocked funds that have been seized Amount
state The state of the block fund BlockState
notes Extra human-readable notes about the block fund String
create_time The time when the block fund was created Timestamp
update_time The time when the block fund was last updated Timestamp
  • Name Description Type
    block_id The ID of the fund block String
    account_id The ID of the deposit account associated with the blocked funds String
    amount The amount of funds that are blocked Amount
    seized_amount The amount of the blocked funds that have been seized Amount
    state The state of the block fund BlockState
    notes Extra human-readable notes about the block fund String
    create_time The time when the block fund was created Timestamp
    update_time The time when the block fund was last updated Timestamp

DeleteFundBlock

DELETE /v1/accounts/deposits/{AccountID}/blocks/{BlockID}

Unblocks a previously blocked fund on a deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to unblock funds from String
block_id The ID of the blocked fund to unblock String

CreateCard

POST /v1/accounts/deposits/{AccountID}/cards

Creates a new card for the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to create a card for String
Request Body (Card)
Name Description Type
card_id The ID of the card String
type The type of the card Type
account_id The ID of the account associated with the card String
  • Name Description Type
    card_id The ID of the card String
    type The type of the card Type
    account_id The ID of the account associated with the card String

ListCards

GET /v1/accounts/deposits/{AccountID}/cards

Lists the cards for the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to list cards for String
page_token The page token of the page to retrieve String
page_size The number of cards to retrieve per page Integer
order_by The field to order the results by String
filter The filter to apply to the list String
  • Name Description Type
    total The total number of cards matching the filter Integer
    remaining The number of cards remaining in the list, including the cards in the response Integer
    cards The list of cards retrieved Array[Card]
    next_page_token The page token of the next page of results String

GetCard

GET /v1/accounts/deposits/{AccountID}/cards/{CardID}

Retrieves a specified card. To retrieve other information on the card, use the cards package under the Services section..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to retrieve a card for String
card_id The ID of the card to retrieve String
  • Name Description Type
    card_id The ID of the card String
    type The type of the card Type
    account_id The ID of the account associated with the card String

DeleteCard

DELETE /v1/accounts/deposits/{AccountID}/cards/{CardID}

Deletes the card for the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to delete the card from String
card_id The ID of the card to delete String

GetDocument

GET /v1/accounts/deposits/{AccountID}/doc/{TemplateID}

Generates a document for the deposit account with the specified template..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account String
template_id The ID of the template to use for the document String
start_time The start time of the transactions to generate transaction history for Timestamp
end_time The end time of the transactions to generate transaction history for Timestamp
  • Name Description Type
    content The raw content of the file encoded in base64 Bytes

GetFundedAccounts

GET /v1/accounts/deposits/{AccountID}/funding

Retrieves the loan accounts which are funded by the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to retrieve the loans for String
  • Name Description Type
    account_ids The list of IDs of associated loan accounts Array[String]

ApplyInterest

POST /v1/accounts/deposits/{AccountID}:applyInterest

Applies the accrued interest to the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to apply interest to String
Request Body (AccruedInterest)
Name Description Type
is_payment_holidays The flag to indicate that the interest accrues on payment holidays Boolean
payment_holidays_rate The amount of the Payment Holidays interest to apply Float(64)
notes The extra notes on the accrued interest String
start_time The time when the interest begins to accrue Timestamp

ReopenAccount

POST /v1/accounts/deposits/{AccountID}:reopen

Reopens a previously closed deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to reopen String
Request Body (ReopenDetails)
Name Description Type
notes The extra notes on the reopening String

Mature

POST /v1/accounts/deposits/{AccountID}:mature

Starts the maturity period for the deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account String
Request Body (NewMaturity)
Name Description Type
mature_time The time when the deposit account will begin Timestamp
notes The extra notes on the maturity String

UndoMaturity

DELETE /v1/accounts/deposits/{AccountID}:undoMaturity

Undos the maturity period on a deposit account..

Parameters
Name Description Type
Query Parameters
account_id The ID of the deposit account to undo the maturity for String

Account

A deposit account where a customer holds his savings..

Name Description Type
account_id The ID of the account String
name The name of the account String
notes Extra notes on the account String
holder_id The ID of the entity that holds the account String
holder_type The type of the entity that holds the account Entity
state The state of the account AccountState
type The type of the deposit account AccountType
accrued_amounts Details related to a deposit account's accrued amounts AccruedAmounts
assigned_branch_id The ID of the branch the account is assigned to String
assigned_centre_id The ID of the centre the account is assigned to String
assigned_user_id The ID of the user the account is assigned to String
balances The account's balances Balances
revolving_account_id The ID of the revolving account the account is register to String
currency_code The currency code of the account String
interest_settings The account's interest settings DepositInterestSettings
internal_controls Internal controls related to the account InternalControls
settlement_account_ids The IDs of the list of settlement accounts the account is linked to Array[String]
migration_event_id The ID of the migration event the account is imported from String
overdraft_rate_settings The account's overdraft interest rate settings OverdraftRateSettings
overdraft_settings The account's overdraft settings OverdraftSettings
product_id The ID of the product the account is created from String
withholding_tax_source_id The ID of the withholding tax source String
create_time The time the account was created Timestamp
approve_time The time the account was approved Timestamp
activate_time The time the account was activated Timestamp
update_time The time the account was last updated Timestamp
close_time The time the account was closed Timestamp
appraise_time The time the account was last evaluated for interest calculations/maturity Timestamp
interest_calculate_time The time the account last had its interest calculated Timestamp
interest_store_time The time the account last had its interest applied (stored to balance) Timestamp
overdraft_interest_review_time The time the account was last reviewed for overdraft interest Timestamp
arrears_set_time The time the account was set to In Arrears state, or null if the account is not In Arrears state Timestamp
lock_time The time the account was locked Timestamp
mature_time The time the account matures for fixed or compulsory savings plans Timestamp

AccountDetails

The information of the account involved in a transaction..

Name Description Type
account_id The account ID details for the transaction String
id_type The type of the account ID String
name The name of the account String
currency_code The ISO3 currency code of the currency being used by the account String
bic The business identification code of the financial institution servicing the transaction String

AccountState

The state of a deposit account..

Name Description
PendingApproval
Approved
Active
ActiveInArrears
Matured
Locked
Dormant
Closed
ClosedWrittenOff
Withdrawn
ClosedRejected

AccountType

The type of a deposit account..

Name Description
CurrentAccount
RegularSavings
FixedDeposit
SavingsPlan
InvestorAccount

AccruedAmounts

The accrued amounts of a deposit account..

Name Description Type
interest The amount of positive interest that has been accrued in the account Amount
negative_interest The amount of negative interest that has been accrued in the account Amount
overdraft_interest The amount of overdraft interest that has been accrued in the account Amount
technical_overdraft_interest The amount of technical overdraft interest that has been accrued in the account Amount

AccruedInterest

The accrued interest information..

Name Description Type
is_payment_holidays The flag to indicate that the interest accrues on payment holidays Boolean
payment_holidays_rate The amount of the Payment Holidays interest to apply Float(64)
notes The extra notes on the accrued interest String
start_time The time when the interest begins to accrue Timestamp

Balances

The balances of a deposit account..

Name Description Type
total The current balance of the account Amount
available The available balance of the account Amount
locked The amount of balance that is locked and cannot be modified Amount
blocked The sum of all blocked balances of the account Amount
fees_due The amount of fees due to be paid on the account Amount
forward_available The sum of all authorization hold that have credit referencing this account Amount
hold The sum of all authorization hold that have debit referencing this account Amount
overdraft_amount The amount of money that has been taken out as overdraft Amount
overdraft_interest_due The amount of interest due to be paid on the account Amount
technical_overdraft_amount The amount of money that has been taken out as unplanned overdraft Amount
technical_overdraft_interest_due The amount of interest due to be paid on the account as a result of technical overdraft Amount

BlockState

The current status of a fund block..

Name Description
Pending
Seized
Removed
PartiallySeized

FundBlock

A block of funds on a deposit account. These sends can then later be seized..

Name Description Type
block_id The ID of the fund block String
account_id The ID of the deposit account associated with the blocked funds String
amount The amount of funds that are blocked Amount
seized_amount The amount of the blocked funds that have been seized Amount
state The state of the block fund BlockState
notes Extra human-readable notes about the block fund String
create_time The time when the block fund was created Timestamp
update_time The time when the block fund was last updated Timestamp

InterestRateType

The type of interest rates on a deposit account..

Name Description
FixedRate
IndexRate

InternalControls

The internal controls of a deposit account..

Name Description Type
max_deposit_balance The maximum deposit balance of the account Amount
max_withdrawal_amount The maximum amount that can be involved in a withdrawal Amount
recommended_deposit_amount The recommended deposit amount for the account Amount
target_amount The target amount for the account Amount

NewMaturity

The information for a new deposit account maturity..

Name Description Type
mature_time The time when the deposit account will begin Timestamp
notes The extra notes on the maturity String

OverdraftRateSettings

The settings for overdraft rates on a deposit account..

Name Description Type
frequency The amount of time between interest charges to the account Duration
payment_dates The list of all dates interest is paid to the account Array[Timestamp]
terms The terms for interest rate computation InterestRateTerms
tiers A list of tiers of interest rates Array[InterestRateTier]
interest_rate The interest rate for the account Float(64)
review_frequency The frequency of interest rate review Duration
rate_type The method of calculation of interest InterestRateType
spread_rate The rate based on interest accrued and applied for accounts with an interest rate type of IndexRate Float(64)

OverdraftSettings

The overdraft settings for a deposit account..

Name Description Type
allow A flag for enabling overdraft settings Boolean
expire_time The expiration time of the overdraft Timestamp
limit The maximum amount of overdraft allowed Amount

Payment

The payment information and account identification details..

Name Description Type
creditor The payment creditor AccountDetails
debtor The payment debtor AccountDetails
identification The identifiers for the payment PaymentIdentification
service_level The service level under which the transaction should be processed String
remittance Information about the payment items that are intended to match the items of the payment RemittanceInformation

PaymentIdentification

The payment identification details..

Name Description Type
end_to_end_id The ID assigned by the initiating party of the transaction String
instruction_id The ID of the payment instruction String
transaction_id The ID assigned by the initiating party for the transaction String

RemittanceInformation

Information specifying the payment items intended to esttle..

Name Description Type
reference The reference of the creditor's underlying documents String
reference_issuer The entity that assigns the reference type String
reference_type The type of the creditor reference String
other Other, unstructured informatino about the payment String

ReopenDetails

The details for reopening a deposit account..

Name Description Type
notes The extra notes on the reopening String