Add or Remove Account Holders
Banks allow multiple account holders (for example, joint holders) to be recorded on accounts and also allow these account holders to be modified during the life of the account. This section describes how the bank can modify the involved account holders of an existing account.
-
Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers
-
Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers
Posting Restriction
Banks employ posting restrictions to regulate transactions in accounts. Posting restrictions are transaction-based rules that prevent transactions from being posted to an account for the purpose of operational control. A typical business case in which a bank uses a posting restrictions to regulate credits into an account is for non-resident accounts, where there may be restrictions on depositing local currency amounts into the account.
-
Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account
-
Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account
Payment Schedule
A payment schedule is the agreed-upon timeline and frequency for making payments on a loan or credit account. The payment schedule specifies when the payments are due, the amount due, and the total number of payments required to pay off the account.
-
Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on an account
-
Retrieves the payment schedule of an arrangement account
Statement Frequency
Banks generate account statements to notify the customers about the account's activity at defined intervals.
-
Update the statement frequency of an account.
-
Retrieves the statement frequency of an account
Renegotitaion
This service helps you to modify the terms and conditions of the account. You can enable a variety of account maintenance activities, both financial and non-financial. Some of the key maintenance activities are maintenance of account titles, restrictions on account, credit and debit interest information and revisions of settlement account.
-
Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.
Manage Interest
Banks can pay an interest to the customers on credit balances held in their accounts. Credit interest or debit interest can be changed in the account at any time during the entire life cycle of the account.
Update Interest
PUTUpdate the interest conditions of the account such as interest rate, tier details, margin amount etc.
-
Retrieves the interest details of an account such as interest rate , interest type and interest amount
-
Retrieve the past period's interest accruals
-
Retrieves the interest accrued for the current period of an account
-
Retrieves the interest accruals of the previous year
Account Facilities
Facilities for an account control the list of available services or facilities for the arrangement account. For example, if an account has the facility of overdraft, passbook, cheque, and so on can be found using the facility property.
-
Update the service availability for an account like block or unblock of cheque,card,sweep etc.,
-
Retrieves the service availability for an account like block or unblock of cheque,card,sweep etc.,
Manage Cheques and Cards
Below are the service operations and their respective APIs involved in requesting a card.
Card Issue
POSTCreate card issue request with details such as card status, issue date, pin issue date and charges
Update Card
PUTUpdate card issue request with card status, issue date, pin issue date, cancellation date & reason
Remove Issue Card
DELETEDelete or revoke the card issue request for an account
Cheque Issue
POSTIssue a new cheque
-
Update issued cheque details
Remove Cheque Book
DELETEDelete the issued cheque
Manage Alerts
This service helps you to subscribe or unsubscribe to alerts for events and Digital Account Officer (DAO).
-
Initiate an alert request or external subscription.
-
Initiate an alert request or external subscription.
-
Update alert subscription details
-
Retrieves subscribed alerts details
-
Retrieves eligible alerts for the account
-
Retrieves the details of active alerts for a given account number
Account Settlement
Account settlement information outlines the details of how an account balance is paid or settled, either by the account holder or by a third party. This information can include the amount of the payment, payment method, payment date, and any associated fees or charges.
-
Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc
-
Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc
Manage Limits
Limit information highlights the specific restrictions or caps imposed on certain account activities or transactions. Common types of limits that may be placed on accounts are transaction limits, withdrawal limits, transfer limits, and spending limits.
-
Update the limit conditions of the account with the secondary limit amount and other limit details
-
Retrieves the currency, balances, limit details and arrangement details of the account
Account Dormancy
Account dormancy is a period of inactivity on a financial account, such as a bank account or credit card account, during which no transactions or other account activity occurs. The length of time that an account can remain dormant before it is considered inactive or dormant varies depending on the financial institution and the type of account. Typically, an account is considered dormant if no customer-initiated transactions, such as deposits or withdrawals have occurred for a specified length of time, which can range from six months to two years.
Reset Dormancy
PUTReset the dormant account to active status manually
Update Dormancy
PUTDeactivates the savings account and moves it to given dormancy status.
-
Retrieves the dormancy setup details for the account such as dormancy period, status etc
Stop Payment
Stop payment is a service that allows a customer to stop payment on a check that they have made, typically if the check has been lost, stolen, or if there is an issue with the payment.
-
Initiate a stop cheque request for an account
-
Update an existing stop cheque request for an account
-
Retrieves the list of Payment Stop requests details such Cheque nos, Amount range, Beneficiary, Period and Charge details available for a specific account
-
Retrieves the list of Payment Stop requests available in the system with details such as Account Reference, Cheque nos, Amount range, Beneficiary, Period and Charge details
Change Product
Changing product is the process of switching from one type of account product to another within a same product group offered by the bank or financial institution that may involve additional fees and charges.
Change Product
PUTChange account from one product to another such as changing savings account to current account
-
Update the action such as proof and publish for the specific product
Change Branch
You can transfer an existing account from one branch of a bank or financial institution to another. This service requires the account holders to provide the required information such as their account number, personal identification, and the new branch location.
Change Branch
PUTUpdates the branch of an account
Change Channel
You can update the sourcing channel for the existing customer accounts. Sourcing channel can be prominent information for reporting. The available channels are OLB, and MB.
Change Channel
PUTUpdates the channel of the account
Change Line of Business
In the organization hierarchy, the line of business is defined to distinctly define different cost centers for bank, and align them later to a particular branch depending on its construct and requirement. This endpoint is used to update the line of business.
-
Updates the type of line of business of the account
Notice Withdrawal Conditions
Notice withdrawal is a feature that may be offered on certain types of accounts, such as savings accounts. With notice withdrawal, the account holder must provide advance notice to the financial institution before withdrawing funds from the account. The notice period may vary depending on the account terms and the financial institution's policies
Create a Notice
PUTNotifies the withdrawal of amount from account by providing the withdrawal date and amount etc. This is applicable only for notice type of accounts.
Update Notice
PUTUpdates the notice of withdrawal of amount from account by providing the withdrawal date, bill reference and amount etc. This is applicable only for notice type of accounts.
Cancel Notice
PUTCancels the notification of withdrawal of amount from account.
-
Retrieves the details of notice bills
Migration
Migration of accounts involves the process of updating and transitioning the account from an older or existing account. Below are the service operations and their APIs involved in the process.
Migrate Accounts
POSTMigration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc.
Migrate Bills
PUTCaptures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details
Migrate Balances
PUTCaptures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details
Account Closure
Customers usually initiate account closures. However, banks may also initiate account closure activities for example, when an account is inactive or has a zero, negative, or below a threshold balance for a period of time.
-
Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions
Close Account
PUTPerform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system
-
Calculate the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts
-
Approves account closure information to allow closing of an account which is no longer in use
-
Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges
-
Retrieves the payoff details of an account
Create an Asset
Collection of end points that relate to Tangible asset, arrangement and covenants creation, enables creation of Land & Building, Equipments, Specialised Assets
-
Creates assets that fall under classification of vehicles
-
Creates assets that fall under classification of equipments
-
Creates assets that fall under classification of land & buildings
-
Creates assets that fall under classification of specialised assets.
-
Registers the tangible asset into the system by capturing the basic details like asset class, asset type, cost details, depreciation details.
-
Creation of hire purchase agreement for the customer with terms & conditions.
-
Creation of lease agreement for the customer with terms & conditions.
-
Creation of chattel mortgage agreement for the customer with terms & conditions.
-
Captures and accepts new insurance for an asset, specifying details such as the insurer, coverage amount, policy number, and coverage period.
-
Captures and accepts details based on the the outcome of an inspection, including data such as the inspector, inspection date, status, and any comments about the assets condition.
-
Captures and accepts details when an asset has been inspected and officially accepted by the organization, documenting the data such as acceptance date, accepting party, and status.
-
Captures and accepts details when a vehicle has been inspected and officially accepted by the organization, documenting the data such as acceptance date, accepting party, and status.
-
Activation of an asset finance agreement. This action marks that the asset is delivered to the lessee and the contract terms are initiated.
Subscription
Manage subscription for asset finance contracts & assets
Add Subscriptions
POSTAllows to add base payments (such as rentals) or other add-on payments (such as insurance, or maintencance) for hire purchase , lease , chattel mortgage, and asset finance agreements.
Update Subscriptions
POSTAllows to amend base payments (such as rentals) or other add-on payments (such as insurance, or maintencance) for hire purchase , lease , chattel mortgage asset finance agreements.
Cancel Subscriptions
POSTAllows to cancel base payments (such as rentals) or other add-on payments (such as insurance, or maintencance) for hire purchase , lease , chattel mortgage asset finance agreements.
-
Retrieves the list of subscriptions based on the product line id and optional query parameters such as customerId or agreement id
Arrangement Maintenance
Manage tangible asset contract lifecycle actions
-
Renegotiation of the terms & conditions of the chattel mortgage agreement
-
Renegotiation of the terms & conditions of the lease agreement
-
Rengotiation of the terms & conditions of the chattel mortgage agreement
Update Parties
POSTChange the parties involved in the asset finance agreement. The parties, simply are the customers acting as a lessee, guarantor or joint lessee.
Update Settlement
POSTUpdate the settlement instructions of the customer in order to transact with the asset finance agreement.
Update Officers
POSTChange the relationship/account officers who is dealing with the lessee's agreement.
-
Update payment holiday for leasees , hire purchase and chattel mortgage asset finance agreements
Evidence
Manage subscription for asset finance contracts & assets
-
Captures and accepts details based on the the outcome of an inspection, including data such as the inspector, inspection date, status, and any comments about the assets condition.
-
Captures and accepts details when a vehicle has been inspected and officially accepted by the organization, documenting the data such as acceptance date, accepting party, and status.
-
Captures and accepts details when an asset has been inspected and officially accepted by the organization, documenting the data such as acceptance date, accepting party, and status.
-
Captures and accepts new insurance for an asset, specifying details such as the insurer, coverage amount, policy number, and coverage period.
Update Evidence
PUTUpdate the evidences to specify its approval or rejection status.
Fetch Evidences
GETRetrieves evidence information such as evidence id, description, activity, and effective date.
-
Retrieves the list of newly acquired evidences which require an acceptance action to advance the status to accepted status.
-
Retrieves evidence details for a lease agreement as per the covenants and condition
Asset Maintenance - Vehicles
Manage tangible asset lifecycle
-
Updates the valuation details of fixed assets that fall under classification of asset - Vehicles
-
Updates the incident details of fixed assets that fall under classification of asset - Vehicles
-
Updates the insurance details of fixed assets that fall under classification of asset - Vehicles
-
Updates the maintenance details of fixed assets that fall under classification of asset - Vehicles
-
Updates the inspection details of fixed assets that fall under classification of asset - Vehicles
-
Updates the usage details of fixed assets that fall under classification of asset - Vehicles
-
Updates the officer details who is dealing with the fixed asset that fall under classification of asset - Vehicles.
Asset Maintenance - Equipments
Manage tangible asset lifecycle
-
Updates the valuation details of fixed assets that fall under classification of asset - Equipments
-
Updates the incident details of fixed assets that fall under classification of asset - Equipments
-
Updates the insurance details of fixed assets that fall under classification of asset - Equipments
-
Updates the maintenance details of fixed assets that fall under classification of asset - Equipments
-
Updates the inspection details of fixed assets that fall under classification of asset - Equipments
-
Updates the usage details of fixed assets that fall under classification of asset - Equipments
-
Updates the officer details who is dealing with the fixed asset that fall under classification of asset - Equipments
Asset Maintenance - Land and Buildings
Manage tangible asset lifecycle
-
Updates the valuation details of fixed assets that fall under classification of asset - Land & Buildings
-
Updates the incident details of fixed assets that fall under classification of asset - Land & Buildings
-
Updates the insurance details of fixed assets that fall under classification of asset - Land & Buildings
-
Updates the maintenance details of fixed assets that fall under classification of asset - Land & Buildings
-
Updates the inspection details of fixed assets that fall under classification of asset - Land & Buildings
-
Updates the usage details of fixed assets that fall under classification of asset - Land & Buildings
-
Updates the officer details who is dealing with the fixed asset that fall under classification of asset - Land & Buildings
Manage Transactions - Repayment - Outstanding Bills
Manage repayment of bills
-
Repayment of outstanding bills of an asset finance agreement which are due for payment.
Enquiries - Asset Finance
Catalogue of enquiries that provide information related to Tangivle asset contract
Fetch Agreements
GETRetrieve all the asset finance agreements of a customer.
-
Retrieve the repayment schedule of the asset finance agreement like payments and payment dates. The options for Keyword - FULL, NEXT. FULL retrieves the full repayment schedule. NEXT retrieves the next payment schedule.
-
Retrieves the lease agreement balance details such as balance type, balance description and balance amount.
-
Retrieves the lease agreement term details such as lease type, term, maturity option and amount
-
Retrieves simulated lease agreements details such as agreement ids, product name, start date, maturity date and finance amount.
-
Retrieves customer simulated lease agreements with details such as agreement ids, product name, start date, maturity date and finance amount.
-
Retrieves agreement charge details such as charge property, charge type, currency and amount.
-
Retrieves the lease agreement term details such as lease type, term, maturity option and amount
-
Retrieves the list of subscription plans that are expiring in given number of days.
-
Retrieves the eligible subscription plans of financial arrangement to be added in the financial arrangement
Enquiries - Fixed Asset
Catalogue of enquiries that provide extensive information on the Tangible assets, its lifecycle actions & status
-
Retrieves the valuation details of the asset like valuation date, currency, amount, method & type
-
Retrieves the incident details of the asset like incident date, incident type, authority reported & other party details
-
Retrieves the insurance details of the asset like policy number, policy start date, policy expiry date, coverage limit, premium amount
-
Retrieves the maintenance details of the asset like date, usage, supplier reference, invoice amount, service cost & service cost type
-
Retrieves the inspection details of the asset like date, usage, estimated total repair cost, estimated total repair duration & Spare parts details
-
Retrieves the usage details of the asset like usage, usage units, date of activity, date of recording
-
Retrieves the list of activities performed during the life cycle of a fixed asset by querying based on asset id, start date, end date, activity id. Asset Id is mandatory querying parameter
-
Retrieves the unauthorised activities such as register,purchase,capital improvement, transfers,disposal, writeoff performed during the fixed asset life cycle.
-
Retrieves the details of accounting entries for a specific transaction that includes entry reference , account number , name , transaction code , date , amount , currency and narrative.
-
Retrieves all the unauthorised non-financial activities of fixed assets such as updating basic details, vehicles, equipments, land & buildings, incident, inspection, insurance, valuation, maintenance, usage
-
Retrieves all the authorised non-financial activities of fixed assets such as updating basic details, vehicles, equipments, land & buildings, incident, inspection, insurance, valuation, maintenance, usage.
-
Retrieves the unauthorised supplier payments resulted during work in progress, purchase and capital improvement activities during the life cycle of fixed asset.
-
Retreives the summary of fixed asset such as asset class, asset type, asset entity, purchase date, asset cost, original value, depreciation details, market value and ias classification by querying based on asset id or asset status as one of the mandatory parameter.