Create Account
Retail Enterprise Services (RES) enables you to create current, savings, and notice accounts in any currency for single or multiple customers of different segments. This service operation enables customized account creation with options to define limit, interest spreads, statement frequency, joint holding pattern, and payment schedules.
-
Create Account
POSTCreate an account product with the details such as customer identifier, account currency, etc.
-
Create Account
POSTCreate a new consumer account of type checkings or savings.
-
Creates a multi currency account for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, account currency details.
-
Create Sub account
POSTCreate multicurrency sub account
-
Create ISA Accounts
POSTCreate a new Individual Savings Account (ISA) and Additional Permitted Subscriptions (APS) Account for adult customers, Junior Individual Savings Account (JISA) for minor customers
-
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.
-
Retrieves the simulated activity details of an account
Funding an Account
Funding an account refers to the process of adding funds to a specific account or a financial instrument. Funding an account may involve various methods depending on the type of account and the financial institution or service provider.
-
Transfer Funds
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
The booking request type validates the supplied entries can be applied on the account and, if the validations are passed, it creates the asssociated debit/credit booking entries. If a reservation key is indicated in the request, the funds reservation is removed from the account when the booking request is successful. The external payment system or any other system can use this to reflect the entries on the accounts when the payment/transaction is finalized. Adjustment entries for post-closing can be booked by passing the post-closing value date.
-
Update Transfer
PUTAmend attributes of a payment order that is yet to be approved by supervisor
-
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
-
Repays the account amount such as charges, tax etc
-
Performs payout of the given account amount such as charges, tax etc
-
Retrieve a specific order for a given payment order id
-
Retrieve list of authorised payment orders based on a specific criteria
-
Delete Transfer
DELETECancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds
-
Delete a payment order awaiting supervisor approval
-
Performs backdated adjustment and re-accrual for the given savings account. This is used when interest adjustment is required due to backdated rate change or transaction.
Block or Unblock Funds
Banks can block funds on an account in full or partial 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, and fetching 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.
-
Retrieves the reserved funds details such as reason, amount and period of reservation of the 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.
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 Two-way Sweep
POSTInitiate a new sweep transaction for a specific account
-
Update Sweep
PUTUpdates an existing sweep transaction for specific account
-
Sweep Approval
PUTApproves a sweep transaction for specific account
-
Retrieves the list of account links for a sweep to occur.
-
Retrieves the details of specific sweep transaction
-
Delete Sweep
DELETERemove an existing sweep transaction for specific 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
-
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
-
Delete Standing Order
DELETEDelete or revoke standing instructions for a customer
Prerequisite for ISA Products
You can create and update the prerequisites for Individual Savings Account (ISA) products with the details related to ISA subscription processing and reporting.
-
Create prerequisites for Individual Savings Account (ISA) products with the details related to ISA subscription processing and reporting
Manage ISA Portfolio
You can create and update customer-specific Individual Savings Account (ISA) portfolios with subscription adjustments and key dates, ensuring compliance with regulatory requirements.
-
Create ISA Portfolio
POSTCreate a customer wise Individual Savings Account (ISA) portfolio based on information from regulatory authority with details such as subscription adjustment and first subscription date
-
Update the customer wise Individual Savings Account (ISA) portfolio based on information from regulatory authority with details such as subscription adjustment and first subscription date
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. While adding or modifying the account holder details, the account holder can be assigned a role as either a beneficiary owner or a non-beneficiary owner (for example, joint-holder), such as power of attorney holder, accountants, and so on.
-
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
-
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.
-
Change Customer
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Add Party
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Remove Party
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Manage 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, 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
-
Retrieves the payment schedule details of an account
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Statement Frequenecy
Banks generate account statements to notify the customers about the account's activity at defined intervals. The statement frequency can be changed from an existing frequency to any other allowed frequency, such as daily, weekly, monthly, or a customised frequency.
-
Update the statement frequency of an account.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Interest Rate
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 condition of an account
Interest Accrual
Interest accrual is the accumulation of interest on funds that are deposited into an interest-bearing account over a period of time. It can occur daily, monthly, quarterly, or annually depending on the account terms.
-
This API is deprecated as it is an invalid endpoint
-
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
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Renegotiation
Renegotiation involves modifying 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.
-
Renegotiation
PUTPerform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.
-
Renegotiation
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Update Action
PUTUpdate the action such as PROOF and PUBLISH for the specific product-This API is deprecated
Posting Restrictions
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
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Request Card and Cheque
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
-
Retrieves the card details of the account such as card number, card type, issue date, cancellation date, reason & status of the card
-
Remove Issue Card
DELETEDelete or revoke the card issue request for an account
-
Cheque Issue
POSTIssue a new cheque
-
Update issued cheque details
-
Retrieves the issued cheques list
-
Retrieves the Cheques details
-
Remove Cheque Book
DELETEDelete the issued cheque
Account Settlement Information
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
-
Modify existing account information like, customer and ownership information, settlement accounts, charges 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
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. You can perform account product transition on accounts of upsell products, non-staff to staff account transition. The new product for the account must be in the same group as the old product. For example, standard savings account can be changed to salary savings account by adding or removing certain conditions.
-
Change Product
PUTChange account from one product to another such as changing savings account to current account
-
Change Product
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Update the action such as proof and publish for the specific product
Change Channel and Branch
Below are the service operations and their respective APIs involved in the Change Channel and Change Branch life cycle.
-
Change Channel
PUTUpdates the channel of the account
-
Change Branch
PUTUpdates the branch of an account
Change Line of Business
You can update the the type of line of business of the account.
-
Updates the type of line of business of the account
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.
-
Create Stop Payment
POSTInitiate 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
-
Get Stop Payment
GETRetrieves 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
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 6 months to 2 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
-
Set Dormancy
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Reset Dormancy
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
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.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Retrieves the charge details of an account
-
Retrieves the details of all the types of bills
Outstanding Bills
You can fetch details of outstanding bills, such as penalties, account opening fees, and maintenance fees, associated with the deposit account.
-
Adjust Bills
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Retrieves the outstanding amount to be paid for an account
Closure of Account
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. If an account has positive balance (credit balance), then the customer can request the bank to transfer the balance amount to another domestic or international account. If the balance is negative (debit balance), the bank has to ensure that the customer repays the outstanding debit balance transferring funds from another account. However, if the banks cannot reach the customer to bring the account to positive status, they can write off and close the account.
-
Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions
-
Account Closure
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
-
Unsubscribe ISA Accounts
DELETECancellation of subscription for Individual Savings Account (ISA), Junior Individual Savings Account (JISA) and Additional Permitted Subscriptions Account (APS)
-
Close ISA Accounts
POSTClose an existing Individual Savings Account (ISA), Junior Individual Savings Account (JISA) based on customer request
-
Calculate the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts
-
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
-
Approves account closure information to allow closing of an account which is no longer in use
-
Retrieves the payoff details of an account
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Limit Information
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 Limit
PUTUpdate 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
-
Update Limit
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Manage Alerts
Below are the service operations and their APIs involved in subscribing and unsubcribing alerts.
-
Initiate an alert request or external subscription.
-
Create Alert - DAO
POSTInitiate an alert request or external subscription.
-
Update alert subscription details
-
Retrieves subscribed alerts details
-
Retrieves eligible alerts for the account
-
Active Alerts
GETRetrieves the details of active alerts for a given account number
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 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.
Update Customer Tax
You can change the tax-related conditions on all account types.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Update Customer
Update Customer Elect Fed WHT allows for modifying the selected withholding details for federal taxes at the account level, enabling adjustments to tax withholding from employee paychecks.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Update Lead Account
You can update lead account details within a combined statements structure using the Update Lead Account service operation.
-
Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Facility
Facility for an account controls the list of available services or facilities for the arrangement account. For example, if an account has the facility of overdraft, passbook, cheque etc can be found using the facility property.
-
Update Facility
PUTModify existing account information like, customer and ownership information, settlement accounts, charges etc,.
Migration
Below are the service operations and their respective APIs involved in migration of accounts, bills and account balances.
-
Accounts Migration
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.
-
Captures 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
-
Captures 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
Add or Remove Account Holders
Below are the service operations and their respective APIs involved in adding, modifying, and removing account holders.
-
Update the customer details of the multi currency account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers and GL allocation percentage.
-
Update the customer details of the multi currency account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers and GL allocation percentage.
Block or Unblock Funds
Banks can block funds on an account, in full or partially, 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, and fetching fund blocking information.
-
Add Fund Block
POSTCreates 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.
-
Get Fund Block
GETRetrieves the reserved funds details such as reason, amount and period of reservation of the account
-
Remove Fund Block
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.
Posting Restrictions
Below are the service operations and their respective APIs involved in adding, modifying, and removing a posting restriction.
-
Update the account details to change the account title, short name, mnemonic, alternate id of the multi-currency account and also to add or remove posting restrictions in the multi-currency account
-
Update the account details to change the account title, short name, mnemonic, alternate id of the multi-currency account and also to add or remove posting restrictions in the multi-currency account
Payment Schedule
You can update the payment schedule of an account by changing payment frequency, payment date, and so on.
-
Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on a multi currency 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 various types of balances such as cleared, online, locked and usable balance of the account
-
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 list of multi currency accounts associated with a customer. The details include account number, ledger balance, available balance, etc.
Sub Account Information
You can fetch all the sub accounts linked to a multi-currency account by specifying the multi-currency account ID in the request.
-
Retrieves the list of multi currency sub account accounts associated with a mutli currency account.The details include account number, ledger balance, available balance, etc.
Change Channel
You can update the channel of the multi-currency accounts.
-
Change Channel
PUTUpdates the channel of the multi currency account
Channel Product
You can change the product of the multi-currency account from one product to another. When the product of a multi currency account is changed, the product of the sub accounts under that multi-currency account are also automatically changed to the sub-account product of the new multi-currency account product.
-
Channel Product
POSTUpdate the product of the multi currency account to another product. When the product of a multi currency account is changed, the product of the sub accounts under that multi currency account are also automatically changed to the sub account product of the current (new) multi currency account product.
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.
-
Fees and Charges
GETRetrieves the charge details of an account
Product Condition
Product conditions are a set of terms and requirements attached to the product. You can retrieve the list of all product conditions associated with a product.
-
Retrieves the catalogued conditions of a given product
-
Retrieves the details of a given product
Position Transfer
You can create an internal position transfer between two currency accounts of a multi-currency account. The payload should include debit currency, credit currency and the amount to be transferred.
-
Position Transfer
POSTCreates an internal position transfer between two currency accounts of a multi-currency account. The payload should include debit currency, credit currency and the amount to be transferred.
Sweep Priorities
You can update currency priority rules for automatic position transfer between the sub accounts (of different currencies) in the same multi-currency account with position adjustment and adjustment order information.
-
Sweep Priorities
PUTUpdates currency priority rules for automatic position transfer between the sub accounts (of different currencies) in the same multi currency account with position adjustment and adjustment order information.
Update Settlement Information
You can update the settlement conditions of the multi-currency account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, and so on.
-
Update the settlement conditions of the multi currency account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc
Account Closure
Below are the service operations and their respective APIs involved in settling payoff and closure of account.
-
Payoff Settlement
POSTPerform the settlement of payoff amount for the multi currency account by providing the transaction amount, currency and also settlement instructions
-
Perform the closure of the multi currency account after settlement of payoff amount
-
Calculate the payoff amount for the multi currency account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts
-
Retrieves the payoff bill after payoff calculations is initiated. The payoff amount for the multi currency account includes account balances, interest, and charge amounts.
Account Activities
Account activities refer to various transactions and events that occur on a financial account. The activities may include payments, interests, purchases, transfers, deposits, withdrawal and so on.
-
Retrieves the activity log of an 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
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 various types of balances such as cleared, online, locked and usable balance of the account
-
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 status of the given activity
-
Retrieves the currency, balances, limit details and arrangement details of the account
-
Retrieves a customer wise Individual Savings Account (ISA) portfolio with details of the subscription and withdrawal trasnactions for ISA savings and deposits initiated by a customer
-
Retrieve a customer wise Individual Savings Account (ISA) portfolio based on information from regulatory authority with details such as subscription adjustment and first subscription date
-
Retrieves the currency, balance and category details of the internal account
-
Account Search
GETRetrieves the currency, balances, limit details and arrangement details of the account
-
Retrieves the charge details of an account
-
Retrieves the details of all the types of bills
-
Fetch Dates
GETRetrieves the key dates of an account
-
Retrieves the details of account transaction
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. You can modify existing account information like, customer and ownership information, settlement accounts, charges etc,.
-
Retrieves the statement frequency of an account
-
Retrieves the statement details of the transactions for the given multi currency account such as booking date, value date, transaction reference, transaction code, debit or credit amount based on the given value date and transaction count. If value date is not given, retrieves the transactions with the value date lesser than or equals to today. If transaction count is not given, retrieves the last 10 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 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
-
Retrieves the details of all the types of bills
Outstanding Bills
An account may have outstanding bills in the form of penalties, account opening fees, and maintenance fees. You can retrieve the outstanding amount to be paid for the deposit account as on the enquiry date.
-
Retrieves the outstanding amount to be paid for an account
Product Details
This topic explains how to retrieve the product features and conditions.
-
Retrieves the catalogued conditions of a given product
-
Product Features
GETRetrieves the details of a given product
Create Deposits
Deposit accounts allow the customers to create short-term or long-term deposits with the facility to make early or partial withdrawals on the funds deposited. You can open a deposit account in any currency for single or multiple customers of different segments. This service operation enables deposit creation with options to define account holding pattern, renewal instruction, funding, and settlement instruction & statement frequency.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.
-
Create Deposits
POSTCreate a new term deposit account
-
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
When funds are blocked, it means that a specific amount or the whole sum in an account is held back for a set or unspecified duration. Banks can block funds on a term deposit, in full or partially, for a specific period or indefinite.
-
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.
-
Retrieves the reserved funds details such as reason, amount and period of reservation of the 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.
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 penalities or fees.
-
Withdraw from the deposit account
-
Update term deposit
-
Adjust Interest
PUTUpdate term deposit
Add or Remove Account Holders
It is a common banking practice to have more than one party, for example joint-holders, in a term deposit. This section describes how a bank can maintain the term deposit contract by adding or removing parties to an existing term 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
-
Update term deposit
-
Update term deposit
-
Update term deposit
-
Update term deposit
-
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.
Manage 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
-
Update term deposit
-
Retrieves the payment schedule details of an account
-
Retrieves the payment schedule of an arrangement account
Manage Interest
You can modify the conditions regarding debit or credit interest rates for an account. This entails changing the interest rate, altering the frequency of interest payouts, or modifying any fees or penalties linked to the account.
-
Update the interest conditions of the term deposit such as interest rate, spread, margin etc
-
Update term deposit
-
Retrieves the interest condition of an account
-
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
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
-
Update term deposit
-
Update term deposit
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. You can update the terms and conditions of a deposit agreement between a bank and a customer. This includes account maintenance activities (financial and non financial) and key maintenance such as account titles, restrictions on accounts, credit and debit interest details, and revision of settlement account details.
-
Perform the renegotiation of the term deposit contract details such as payment frequency, interest rates, etc.
-
Update term deposit
-
Update term deposit
-
Update term deposit
-
Update term deposit
-
Update term deposit
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. You can change the product of the deposit during campaigns, new product launch, up sell and so on. The new product for the deposit should be in the same group as the old product.
-
Change Product
PUTUpdate the contract from one deposit product to another
-
Change Product
PUTUpdate term deposit
Change Branch
You can shift an active account of a customer from one branch to another.
-
Change Branch
PUTUpdate 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.
-
Update the settlement conditions of the term deposit such as payin account, payout account, beneficiary etc
-
Update term deposit
-
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
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
PUTPerform 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
-
Deposit Renewal
PUTUpdate term deposit
-
Update Term
PUTUpdate term deposit
-
Update term deposit
-
Update term deposit
Fees and Charges
You can retrieve the charges associated with the deposit. The charge information such as the reason for the charge, change amount, and charge date can be retrieved.
-
Fees and Charges
GETRetrieves the charge details of an account
Adjust Bills
You can adjust existing bills for the deposit, and change or capitalise the redemption fee.
-
Update term deposit
Closure of Deposits
Closure of a deposit account refers to terminating a term deposit account before its maturity date.
-
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
POSTSimulates a deposit redemption that includes 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
Update Tax
You can update the tax conditions, tax properties, net tax, and so on for the deposit account.
-
Update Tax
PUTUpdate term deposit
-
Update term deposit
-
Update term deposit
Manage Alerts
You can subscribe to alerts associated with the servicing of the life-cycle activities associated with the deposit account.
-
Update term deposit
Notice Withdrawal Conditions
Notice withdrawal is a feature that may be offered on certain types of deposits 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 Notice
PUTNotifies the withdrawal of amount from deposit account by providing the withdrawal date and amount etc. This is applicable only for notice type of deposits.
-
Update Notice
PUTUpdates the notice of withdrawal of amount from deposit account by providing the withdrawal date
-
Cancel Notice
PUTCancels the notification of withdrawal of amount from deposit account by providing the withdrawal date
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 Account Activities
You can retrieve the transaction history of deposit accounts, detailing a range of financial and non-financial activities, including deposits, withdrawals, payments, transfers, interests, purchases, and more.
-
Retrieves the activity log of an account
Deposit Information
Deposit information encompasses details concerning the balance and status of a deposit account, encompassing all deposits, accrued interest, and other credits, alongside withdrawals, fees, and debits. The status indicates whether the account is open, closed, or on hold.
-
Retrieves various types of balances such as cleared, online, locked and usable balance of the account
-
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 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 key dates 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 business start and end dates for each payment type defined in payment schedule condition
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
-
Simulates a deposit redemption that includes 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.
Fees and Charges
Fees and charges are the cost associated with maintaining a deposit account and using its various services and features. These costs can vary depending on the type of deposit and the specific services used by the account holder.
-
Retrieves the charge details of an account
Bill Details
You can fetch details of outstanding bills, such as penalties, account opening fees, and maintenance fees, associated with the deposit account.
-
Retrieves the outstanding amount to be paid for an account
Product Details
Product details involves retrieving product features and conditions attached to a product.
-
Product Features
GETRetrieves the details of a given product
-
Retrieves the catalogued conditions of a given product
Create Loan
The create loan functionality enables the customer to create a short-term loan (for example, three months) or a long-term loan (for example, 25 years) with or without collateral, based on the selected product. Some loans have a defined maturity date, while the others have the capability to be renewed or rolled over when the loan reaches the maturity date.
-
Consumer Loan
POSTcreates a consumer loan for the given product
-
Line of Credit
POSTcreates a consumer loan for the given product
-
Consumer Loan
POSTNew consumer loan creation API
-
Line of Credit
POSTBook a new consumer line of credit
-
Create BNPL Drawing
POSTNew consumer loan creation API
-
Personal Loan
POSTCreates a loan for the given product
-
Vehicle Loan
POSTCreates a vehicle loan for the given product
-
Home Equity
POSTCreates a loan for the given product
-
Mortgage Loan
POSTCreates a mortgage loan with insurance policy taken to cover the credit risk for the customer's loan and capture rate lock interest details used to apply lowest of rate lock interest and carded rate.
Loan Drawdown
This topic explains the service operations and the APIs involved in creating a loan drawdown offer, negotiating the offer, and accepting the offer.
-
Loan Drawdown Offer
POSTCreates a new drawdown offer for the required customer.
-
Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.
-
Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.
-
Cancellation of offer drawdown for the required customer.
Loan Disbursement
<p>Loan disbursements refer to the drawdown of the loan principal, which can be in a single disbursement or in tranches. The proceeds of the disbursal can be channelised into customer or customer authorised account available within the bank or externally. In the former case, loan disbursements can be automatic (using a settlement account) or manual. In the latter case, funds can be transferred to another bank using clearing and other payment mechanisms.</p>
-
Create the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Creates a disbursement of the given consumer loan contracts commitment amount
-
Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status
Loan Repayment
Banks can use this feature to make payments of due amounts. The sequence of priority in which the repayment amount is settled against is defined during product configuration. You can create a payment order to move funds from loan account to funding account by specifying the details such as currency, debit amount, initiation type, credit account, and so on.
-
Repay Loan
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Create a simulation for loan product with details like customer identifier, currency, etc.
-
Retrieves the repayment schedule details for an arrangement with simulation reference number
Payoff Loan
Loan pay off is the pre-closure of a loan in a single payment before the actual maturity of the loan tenure. Pay off can also be called foreclosure, early closure or early settlement of a loan account. Loan pay off involves functions like simulation of outstanding amount payable and distinct function for pay-off loan based on the simulation.
-
Loan Payoff
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Partial Payoff
PUTCreates the advance repayment of the given consumer loan amount
-
Payoff Simulation
POSTCreate a simulation payoff activity for loan product with product id details
-
Retrieves the payoff details of a loan
-
Settle Payoff
POSTExecute payoff activity for loan product with details like simulation run reference, product id , etc.
-
Create the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
Register Direct Debit
You can repay loans though an account in another bank. The direct debit information with details of the account in another bank can be captured and linked to the loan. The direct debit instruction has to be automatically sent to another bank based on the loan payment schedule.
-
Create direct debit instructions for repayment of loans or bill payment through external accounts
Manage Interest
This topic explain the service operations and their associated APIs involved in updating and retrieving interest related information.
-
Update the interest conditions of the loan such as interest rate, spread, margin etc
-
Renegotiate existing consumer loan conditions
-
Renegotiate consumer line of credit conditions
-
Retrieves the interest condition of an account
-
Retrieves the interest accrued for the current period of an account
-
Retrieves the interest accruals of the previous year
-
Retrieve the past period's interest accruals
Payment Holiday
The payment holidays are a temporary suspension of payments on loans due to unforeseen circumstances. Banks can easily update payment holiday information, including the start and end dates, payment amount, and other relevant details. This can help customers avoid missed payments, late fees, and other penalties. When Payment Holiday is in effect, the customer can only skip complete payment. The customer will not be charged any fee or penalty for the loan repayment breaks when payment holiday is in effect. However, the interest is accrued, which increases the repayment amount post payment holiday.
-
Initiate update payment holiday activity for a personal loan
-
Initiate update payment holiday activity for a credit line
-
Simulate payment holiday activity for a loan account
-
Retrieves payment holiday simulation details for the loan such as payment type, holiday date, original payment amount and new payment amount
-
Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount
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, how much is due for each payment, and the total number of payments required to pay off the account.
-
Retrieves the schedule payment information for paid and upcoming installments details
-
Retrieves the schedule payment information for paid and upcoming installments details
-
Change Schedule
PUTPerform repayment date change for the loan product with details like loan reference, product id , etc.
Increase and Decrease Commitment Amount
A commitment for a loan is the undrawn or undisbursed amount of the loan. When a loan is initially sanctioned and yet to be disbursed, the loan commitment is the original sanctioned amount. If there is a partial disbursement, the loan available commitment is the un-disbursed part of the loan. Based on the customer’s repayment history, most commercial banks provide top up facility on the existing loan after the specified time defined by the banks. This facility is available for all types of loans. For a loan top up, the banks reassess the customer’s eligibility for the top-up value and sanctions either with minimal or zero documentation. Sometimes the customer does not require the entire loan amount that was previously sanctioned and requests a reduction in the commitment before disbursement. This is common in case of construction or home improvement loans. Banks may also suggest the customer to reduce the undrawn commitment to facilitate another loan.
-
Increases the commitment amount of the loan
-
Renegotiate existing consumer loan conditions
-
Renegotiate consumer line of credit conditions
-
Decreases the commitment amount of the loan
-
Renegotiate existing consumer loan conditions
-
Renegotiate consumer line of credit conditions
Update Settlement Instruction and Change Account Holding
The service operations that are required for changing the original terms of the loan contract are described here. Loan Maintenance service operations can be financial and non-financial in nature. The collection of service operations that cater end to end lifeycle of loan are as follows:
-
Renegotiate existing consumer loan conditions
-
Renegotiate consumer line of credit conditions
-
Add Beneficiary
POSTCreate a beneficiary for account transfers or bill payment
-
Updates the customer for the given loan contract
Change Product
Changing product is the process of switching from one type of loan product to another within a same product group offered by the bank or financial institution that may involve additional fees and charges. You can perform loan product transition on Loans of upsell products, by changing loan from one product to another.
-
Change Product
PUTChange loan from one product to another such as changing one loan product to another loan product
Change Loan Conditions
The service operations that are required for changing the original terms of the loan contract are described here. Loan Maintenance service operations can be financial and non-financial in nature. The collection of service operations that cater end to end lifeycle of loan are as follows:
-
Perform repayment date change for the loan product with details like loan reference, product id , etc.
-
Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.
-
Update the account conditions of the loan such as alternate references, posting restrictions, etc
-
Update static information of mortgage like title name, origination reference and also to link insurance policy taken to cover the credit risk for the customer's loan
-
Perform repayment date change for the loan product with details like loan reference, product id , etc.
-
Renegotiate Loan
PUTPerform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.
-
Renegotiate Loan
PUTRenegotiate existing consumer loan conditions
-
Renegotiate consumer line of credit conditions
-
Cancel Loans
PUTPerforms the full loan cancellation incase of preshipment return of products under buy now pay later loan.
-
Renegotiate existing consumer loan conditions
-
Renegotiate consumer line of credit conditions
-
Renegotiate existing consumer loan conditions
-
Renegotiate consumer line of credit conditions
-
Updates the customer for the given loan contract
Delinquency Management
This topic explains the service operation that relate to past due loans where the bank prefers to charge off or write off on account of contingencies.
-
Loan Write-off
PUTPerform a write off of the balances and bills such as principal or interest or charge amount for the unpaid loans
-
Loan ChargeOff
PUTExecute loan charge-off activity to charge-off account balance only
Migration
Below are the service operations and their respective APIs involved in migration of loans, bills and loan balances.
-
Loan Migration
POSTMigration of a legacy system loan contract to the given product by providing the original contract date, principal amount, term, payment frequency and start date, etc.
-
Captures the bill information of the loan 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
-
Captures the balance details of the mortgage loan 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.
Create Facility
This topic explains the Create Facility service operation and the API involved in it.
-
Creates retail facilities
-
Create BNPL Facility
POSTCreate an installment loan for the given product
Manage Facility Lifecycle
Credit Facility is a line of credit extended by the bank to the customers against a specific product or purpose, which enables the customer to draw on the facility in the form of one or more loans.
-
Increase the commitment amount of the credit agreement (facility) with the incremental amount
-
Decrease the commitment amount of the credit agreement (facility) by the specified amount
-
Decrease/Increase the maturity period of the facility
Manage Limits and Collateral
This topic explains service operations related to collaterals.
-
Create Limit
POSTAllows creation of credit limit for customer with information such as limit product, sanctioned amount, currency, expiry date and review frequency of limit - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/unsecuredLimits(createUnsecuredLimits) or /holdings/creditLimits/limits/securedLimits(createSecuredLimits)
-
Update Limit
PUTAllows update of credit limit for customer with information such as sanctioned amount, expiry date, review frequency of limit - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/{limitId}/unsecuredLimits(updateUnsecuredLimits) or /holdings/creditLimits/limits/{limitId}/securedLimits(updateSecuredLimits) or /holdings/creditLimits/limits/{limitId}/limitAmounts(updateLimitAmounts)
-
Retrieves a list of credit lines that the institution has sanctioned to any specific customer - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits(getLimitList) or /holdings/creditLimits/limits/pendingApprovals(getUnapprovedLimits)
-
Create Collateral
POSTCreates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item
-
Create the customer collateral allocation with details such as the collateral type, allocation amount, percentage covered, validity and contracts against which customer collateral has been pledged.
-
Create register of customer's immovabale property with details such as property type, owner, address, market value and currency of asset value.
-
Update the customer collateral allocation with details such as collateral type, allocation amount, percentage covered, validity and contracts against which customer collateral has been pledged.
-
Update register of customer's immovabale property with details such as property type, owner, address, market value and currency of asset value.
-
Updates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item
-
Retrieve the details of the collateral allocation such as collateral type, allocation amount, percentage covered, validity and contracts against which customer collateral has been pledged.
Loan Information
The collection of service operations which provide an overview of financial and non- financial transactions over the lifeycle of the loan are described here.
-
Retrieves the activity log of an account
-
Retrieves the status of a loan
-
Retrieves the status of the given activity
-
Retrieves the details of mortgage including the insurance policy id
-
Retrieves account information, balances, overdraft, interest, payment schedule and joint ownership details
-
API to view loan information like ownership, roles, balances, due amounts, payment history, collateral details, limit, etc,.
-
Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customer id, debit account id, beneficiary nickname, account type, etc
-
Retrieves the statement frequency of an account
-
Fetch Total Dues
GETRetrieves the charge off balances of an arrangement account
-
Retrieves the details of the given loan
-
Retrieves the balance details such as commitment balances, utilized balances.
-
Retrieves the list of loans associated with a customer
-
Retrieves the repayment details of an account based on the payment schedule
-
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
-
Retrieves the details of account transaction
-
Retrieves loan details
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, how much is due for each payment, and the total number of payments required to pay off the account.
-
Retrieves the schedule payment information for paid and upcoming installments details
-
Retrieves the schedule payment information for paid and upcoming installments details
Facility Information
Credit Facility is a line of credit extended by the bank to the customers against a specific product or purpose, which enables the customer to draw on the facility in the form of one or more loans.
-
Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.
-
Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.
-
Retrieves the drawings under a facility
-
Retrieves the available drawing products under the facility
-
API for fetching the facility product catalog-deprecated. The new URL is: api/v1.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts
-
Fetch Drawings
GETRetrieve the drawings details under the facility.
-
Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer.
-
Retrieve the details of the facility.
-
Retrieve the details of the facility.
-
Retrieves the financial summary for a facility arrangement
-
Retrieves the details of mortgage including the insurance policy id
-
Update static information of mortgage like title name, origination reference and also to link insurance policy taken to cover the credit risk for the customer's loan
Collateral Information
The section explains the enquiry related service operations for collateral.
-
Retrieves customer collaterals with details such as collateral name, type, subtype, currency, amount and collateral item. Optional collateral status can be set with CUR - current/active, FWD - future dated, LIQ - liquidated, EXP - expired to get the corresponding collateral details
-
Retrieves the collateral details linked to the loan arrangement.
-
Retrieve the details of the collateral allocation such as collateral type, allocation amount, percentage covered, validity and contracts against which customer collateral has been pledged.
-
Retrieve register of customer's immovabale property with details such as property type, owner, address, market value, currency of asset value and collateral to which the property has been linked.
Reporting Metrics
This topic explains the service operations and their APIs involved in retrieving the metrics of various loan types.
-
Fetch Loans
GETRetrieves the loan details of an account
-
Retrieves the list of approved accounts created from the loan products
-
Retrieves the list of simulated accounts created under the given lending product line
-
Retrieves the list of closed or matured accounts for a given lending product line
-
Retrieves the list of accounts in hold status for the given lending product
-
Retrieves the list of unapproved accounts for the given loan product
Fees and Charges
The collection of service operations which provide an overview of financial and non- financial transactions over the lifecycle of the loan are described here.
-
Retrieves the charge details of an account
Product Details
This topic explains how to retrieve the product catalogue and conditions.
-
Retrieves all the products available in the catalogue
-
Retrieves the catalogued conditions of a given product
Bill Details
The collection of service operations which provide an overview of financial and non- financial transactions over the lifeycle of the loan are described here.
-
Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan
-
Retrieves the outstanding amount to be paid for a loan
BNPL Point of Sale Functions
The service operations that are invoked based on the key milestones of the customer's product purchase journey and each of the point of sale function are tied down to the loan lifecycle. The service operations are as follows.
-
Create the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Retrieves the payoff details of a loan
Create a Payment Order
You can create a payment order for the below payment products by inputting the payment order product and other mandatory fields like debit account, amount, beneficiary IBAN, and so on in Temenos Transact for various scenarios like loan disbursement, merchant fee processing, prepay, and loan repayment.
-
Create Payment Order
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Initate a new instant payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.
-
Funding an Account
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Create a new payment order, this API can be called to validate or commit the orders
Initiate Recall
You can initiate recall when a completed payment needs to be reversed. It can be requested either by the bank or the customer with appropriate reasons.
-
Create a recall in response to a bank operator's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.
-
Create a recall in response to a customer's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.
Accept or Reject Recall
You can initiate recall when a completed payment needs to be reversed. This recall requested by the bank or customer can be either accepted or rejected stating appropriate reasons.
-
Accept Recall
PUTRespond to a recall request for a payment that was made previously. Positive (Acceptance - Willing to Return Funds) or Negative (Rejection - Unwilling to Return Funds) responses are acceptable, but they must be accompanied by a reason (code).
-
Reject Recall
PUTRespond to a recall request for a payment that was made previously. Positive (Acceptance - Willing to Return Funds) or Negative (Rejection - Unwilling to Return Funds) responses are acceptable, but they must be accompanied by a reason (code).
Manage Payments
Manage Payments allows users to accept or reject recall requests, delete beneficiaries, and authorize account transfers for payment processing
-
Delete Beneficiary
DELETEDeletes existing beneficiary of a customer defined for payment processing
-
Approve or reject a payment that is yet to be approved by supervisor
Fetch Information
You can fetch information related to payment order.
-
Retrieves all type of payment transactions
-
Retrieves audit trail which contains information on the lifecycle of a payment. Details can be retrieved for a specific payment or for all payments in the system.
-
Retrieve the status of payment order for a given order id
-
Retrieves the history of all cases associated with a specific payment
-
Retrieve completed payments that are eligible for recall
-
Retrieve the status of an outward recall requests sent for completed payments
Create and Manage Customer
Creating customer profile within the bank's customer database or CRM system enables the banks to target specific customer segments with personalized messages and offers.
-
Create Customer
POSTCreate a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user
-
Create an individual customer prospect, capture and validate the national insurance number during onboarding process
-
Create a new prospect individual, capture and validate the National Insurance Number during onboarding process
-
Create a new prospect entity, capture and validate the legal document during onboarding process
-
Authorize a customer record on verification of the details
-
Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user
-
Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer
Create Customer
Customer creation typically involves collecting and recording the customer's personal information, contact details, and other relevant data such as their purchasing history, preferences, and any other relevant information that can help the business to better serve the customer.
-
Create Customer
POSTAllows creation of an individual customer.
-
Add new customer address information
-
Create customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages
-
Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address
Manage Customer
You can update the customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, and so on provided by the user.
-
Update Customer
PUTUpdates individual customer. Unless there is specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.
-
Retrieves the relationship details for a given customer
-
Update customer primary address
-
Update existing address information for the customer.
-
Remove customer's secondary address information
-
Update customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages
-
Allows update to KYC and tax information for a customer
-
Updates alternate address information for a customer
Enquire Customer Information
You can retrieve the customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, and so on provided by the user.
-
Retrieve customer primary address
-
Search and retrieve customer information
-
Retrieve customer and address
-
Retrieves all available mail addresses for a customer along with information on the purpose of the address(primary, office, etc,.), internal address reference.
-
Retrieves the delivery preferences of the customer such as the message group, carrier and address.
-
Retrieves address information for the account
-
Retrieve customer's credit score information received from credit agencies.
-
Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.
-
Retrieves KYC and tax information for a customer
-
Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address