Create Account
Business & Corporate Enterprise Services (BCES) enables you to create premium, savings, standard, start up and current accounts in any currency for the customers. This service operation enables customized account creation with options to define limit, interest spreads, statement frequency, and payment schedules.
-
Allows to create and manage various types of accounts such as current, savings, corporate, islamic, non-resident and minor accounts created using the Arrangement Architecture. Pool accounts can also be created for Notional pooling purpose
-
Allows to create and manage various types of accounts such as current, savings, corporate, islamic, non-resident and minor accounts created using the Arrangement Architecture. Pool accounts can also be created for Notional pooling purpose
-
Creates a simulation for account product with the details such as customer identifier, account currency, etc.
-
Amend a simulation for account product with the details such as customer identifier, account currency, etc.
Funding an Account
Funding an account refers to the process of adding funds to a specific account or a financial instrument. It may involve various methods depending on the type of account and the financial institution or service provider.
Create Payment Order
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Amend attributes of a payment order that is yet to be approved by supervisor
-
Delete a payment order awaiting supervisor approval
Delete Payment Order
DELETECancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds
-
Perform debit transactions in an account by providing debit amount and currency in which to be debited
-
Perform credit transactions in an account, providing the credit amount and the currency in which to be credited
-
Retrieve a specific order for a given payment order id
-
Retrieve list of authorised payment orders based on a specific criteria
Block or Unblock Funds
Banks can block funds fully or partially on an account for a specific or indefinite period of time. This topic explains the service operations and their APIs involved in initiating, updating, and reversing a fund block. It also explains the APIs to fetch fund blocking information.
-
Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.
-
Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.
Reverse Fund Blocking
DELETECancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.
-
Retrieves the reserved funds details such as reason, amount and period of reservation of the account
Standing Order
A standing order is a type of financial instruction that allows an account holder to authorise a fixed amount of funds to be automatically transferred from their account to another account, typically on a regular basis. The transfer can occur weekly, bi-weekly, monthly, or on any other regular interval specified by the account holder.
-
Create standing instructions with payment type, payment frequency, ordering customer or bank information and accounts involved
-
Update standing instructions with payment type, payment frequency, ordering customer or bank information and accounts involved
Delete Standing Order
DELETEDelete or revoke standing instructions for a customer
-
Approve standing instructions that are sent for second or third level approvals
-
Retrieves the list of standing instructions details such as instruction reference, mode of payment, payment frequency, amount, accounts & customers involved
-
Retrieves the list of standing instructions details such as instruction reference, mode of payment, payment frequency, amount, accounts & customers involved
-
Retrieves the list of failed standing instructions details such as accounts involved, payment type & reason of failure
Account Sweep
Account sweep is a financial service that automatically transfers funds between different accounts to maximise the use of available funds and minimise idle cash balances. It can also be used to pay down outstanding balances on lines of credit or loans. Account sweeps can be performed on a daily, weekly, or monthly basis, depending on the needs and preferences of the account holder.
-
Initiate a new sweep transaction for a specific account
-
Initiate a new sweep transaction for a specific account
Create Twoway Sweep
POSTInitiate a new sweep transaction for a specific account
Update Sweep
PUTUpdates an existing sweep transaction for specific account
Approve Sweep
PUTApproves a sweep transaction for specific account
Delete Sweep
DELETERemove an existing sweep transaction for specific account
-
Retrieves the list of account links for a sweep to occur.
-
Retrieves the details of specific sweep transaction
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
Account Information
Account information refers to the details and data associated with a financial account, such as a bank account, credit card account, or loan account. It includes information such as account holders details, account information, transaction activity, balances and so on.
-
Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status
-
Retrieves the currency, balances, limit details and arrangement details of the account
-
Retrieves the status of the given activity
-
Retrieves various types of balances such as cleared, online, locked and usable balance of the account
-
Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction
-
Retrieves the transaction list for a given Account Number-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/transactions
-
Retrieves the activity log of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/activities
-
Allows to create and manage various types of accounts such as current, savings, corporate, islamic, non-resident and minor accounts created using the Arrangement Architecture. Pool accounts can also be created for Notional pooling purpose
Fetch Simulation
GETRetrieves the simulated activity details of an account
Account Statement
Account statements are issued on a periodic basis and include all debits and credits to a customer account that occurred during the statement period.
-
Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves the transactions for the period.If account id and transaction id are given, retrieves that particular transaction details
-
Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount
Fees and Charges
Fees and charges are the costs associated with maintaining an account and using its various services and features. These costs can vary depending on the type of account and the specific services used by the account holder. This service helps you to fetch the details of charges associated to an account.
Fees and Charges
GETRetrieves the charge details of an account
Outstanding Bills
An account may have outstanding bills in the form of penalties, account opening fees, and maintenance fees. This service helps you to fetch the outstanding amount to be paid for the deposit account as on the query date.
-
Retrieves the outstanding amount to be paid for an account
Product Details
You can use this query to fetch product features and conditions.
Product Features
GETRetrieves the product details for a catalogued product
-
Retrieves the catalogued conditions of a given product
Create Deposits
Deposit accounts allow the customers to create fixed bonds. These bonds are characterized by a fixed interest rate or coupon rate that remains constant throughout the life of the bond.
-
Creates term deposits and the payload should include customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates
Funding of Deposits
Funding of deposits involves depositing funds into deposit account to increase the balance and to potentially earn interest on the deposited amount over time.
-
Fund the term deposit manually by providing the deposit amount
Block or Unblock Funds
Banks can block funds on a deposits account, in full or partially, for a specific or indefinite period of time.
-
Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.
-
Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.
Reverse Fund Blocking
DELETECancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.
-
Retrieves the reserved funds details such as reason, amount and period of reservation of the account
Partial Withdrawal
Partial withdrawal refers to withdrawing a portion of the funds deposited in the account before the maturity date, while leaving the remaining balance intact. This may involve change in interest earned and can also be subject to penalties or fees.
-
Withdraw from the deposit account
Add or Remove Account Holders
It is a common banking practice to have more than one party, for example joint-holders, in a deposit. This section describes how a bank can maintain the deposit contract by adding or removing parties to an existing deposit.
-
Update the customer details of the term deposit such as add or remove joint customers
-
Update the customer details of the term deposit such as add or remove joint customers
-
Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role, their beneficiary type, limit allocation percentage, GL allocation percentage and tax liability percentage.
Posting Restriction
Banks employ posting restrictions to regulate transactions in deposits. Posting restrictions are transaction-based controls, that prevent transactions from being posted for the purpose of operational control. A typical business case in which a bank applies a posting restriction to control credits is for non-resident accounts, where there could be restrictions against the deposit of local currency amounts into the deposit.
-
Update the account conditions of the term deposit such as alternate references, posting restrictions, etc
-
Update the account conditions of the term deposit such as alternate references, posting restrictions, etc
Payment Schedule
A payment schedule for a deposits product is the interest payments that are made on the deposit account. The payment schedule outlines when and how interest payments will be made to the account holder.
-
Update the payment schedule details of the term deposit such as payment frequency, payment type
-
Retrieves the payment schedule details of an account
Manage Interest
Banks can pay interest to the customers on credit balances held in their deposit accounts. The interest can be changed in the following ways
-
Update the interest conditions of the term deposit such as interest rate, spread, margin etc
-
Retrieves the interest details of an account such as interest rate , interest type and interest amount
-
Retrieves the interest accrued for the current period of an account
-
Retrieve the past period's interest accruals
-
Retrieves the interest accruals of the previous year
Renegotiate Deposits
Renegotiating deposits involves negotiating new terms and conditions for a term deposit account before its maturity date. These negotiations may include a change in the original terms of the account, such as the interest rate or the maturity date and so on.
-
Perform the renegotiation of the term deposit contract details such as payment frequency, interest rates, etc.
Renewal of Deposits
Renewal of deposits enables the account holders to extend the term of their deposit account that has reached its maturity date.
Deposit Renewal
POSTPerform the rollover of the deposit for the given rollover date or period
Update Term
PUTUpdate the tenure of the term deposit by providing tenure or maturity date
Change Product
Changing product is the process of switching from one type of deposits product to another within same product group offered by the bank or financial institution that may involve additional fees and charges.
Change Product
PUTUpdate the contract from one deposit product to another
Change Branch
You can shift an active account of a customer from one branch to another.
Change Branch
POSTUpdate the branch for the deposit
Deposit Settlement
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, the payment method, the payment date, and any associated fees or charges.
-
Update the settlement conditions of the term deposit such as payin account, payout account, beneficiary 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
Deposit Closure
Closure of a deposit account refers to terminating a term deposit account before its maturity date. You can use this query to fetch the details related to closure of deposits.
-
Redeem the term deposit to close the deposit by providing the settlement instructions
Deposit Closure
PUTRedeem the term deposit to close the deposit by providing the settlement instructions
Simulate Redemption
POSTSimulate a deposit redemption and the payload should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.
-
Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits
Migration
Below are the service operations and their respective APIs involved in migration of deposits, bills and deposit balances.
Migrate Deposits
POSTMigration of a legacy system deposit contract to the given deposit product by providing the original contract date, account name, statement, payment frequency and start date, etc. This can be used for migrating the legacy contract to deposits account by providing required details.
Migrate Bills
PUTCaptures the bill information of the deposits 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 deposits 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.
Deposit Information
Deposit information includes the information related to the balance and status of a deposit account. Balance details may include all deposits, interest earned, and any other credits to the account, as well as any withdrawals, fees, or other debits that have been made. The status of a deposit account states whether the account is open, closed, or on hold.
-
Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status
-
Retrieves various types of balances such as cleared, online, locked and usable balance of the account
-
Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a customer user interface.
-
Retrieves the activity log of an account
-
Retrieves the deposit details for a given account or a customer
-
Retrieves the list of deposit account for a given customer
-
Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role, their beneficiary type, limit allocation percentage, GL allocation percentage and tax liability percentage.
Deposit Statement
A deposit statement provides a detailed summary of the deposits made into a bank account during a specific period of time.
-
Retrieves the statement frequency of an account
-
Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction
Fees and Charges
Fees and charges are the cost associated with maintaining an account and using its various services and features. These costs can vary depending on the type of account and the specific services used by the account holder.
-
Retrieves the charge details of an account
Bill Details
You can use this query to fetch bill-related information.
-
Retrieves the outstanding amount to be paid for an account
Product Details
You can use this query to fetch product features and conditions.
Product Features
GETRetrieves the product details for a catalogued product
-
Retrieves the catalogued conditions of a given product