Create a Deal
A deal represents a credit agreement between the lender and the borrower that governs the applicable terms of the facilities, which encompass various conditions such as Non-Business Day Rules, Agency Fee, and more. Below are the service operations used to streamline the process of initiating, managing, and tracking deals or transactions.
-
Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.
Accept Deal Offer
POSTOn executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.
Cancel Offer
POSTDeletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.
-
Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations
Create a Facility
You can either create a standalone facility or create, accept, and activate an offer into a facility. A facility can also be merged or split.
-
Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.
-
Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.
-
On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.
-
Creates corporate facilities
Create a Business Loan
You can create start-up loans, small business loans, and other banking loans (flexi pay, risk-free) with or without collateral, based on the selected product. Some loans have a defined maturity date, while others have the capability to be renewed or rolled over when the loan reaches the maturity date. You can create Business Banking (BB), Small Business loan and BB Start Up Loan using this service.
-
Creates a business banking loan for a single or joint customer
-
Creates a new drawdown offer for the required customer.
-
Renegotiate the offer drawdown for the required customer.
-
Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.
-
Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan
-
Creates a drawdown for the specified customer by capturing necessary details such as interest, payment schedule, repayment, and settlement instructions. Through this service, the drawdown will be auto approved on creation.
-
Splits/Merge/Rollover in Drawings level
Repay Facility
You can create a payment order for transferring the funds from an account to a facility arrangement account to repay the facility amount.
-
Create the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
-
Create the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
Repay Facility
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
Disburse Loan
Loan disbursements refer to the drawdown of the loan principal, which can be in a single disbursement or tranches. The proceeds of the disbursal can be channelized into a 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.
Loan Disbursement
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
Repay Loan
You can create a payment order to move funds from a loan account to a 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.
Direct Debit
You can link between a financial institution, or payee, and a drawdown account to facilitate the automatic collection of funds through direct debit.
-
Link the direct debit to an existing drawing under a facility
Payoff Loan
Loan payoff is the pre-closure of a loan in a single payment before the actual maturity of the loan tenure. Payoff can also be called foreclosure, early closure, or early settlement of a loan account. Loan payoff involves functions like a simulation of the outstanding amount payable and a distinct function for payoff loans based on the simulation.
Prepay loan
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
Settle payoff
POSTCreate the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment
Pay off simulation
POSTCreate a simulation payoff activity for loan product with product id details
Change Commitment and Term
The deal commitment amount can be increased based on the customers repayment history or decreased in the case of customer request after deal creation. It is also possible to update the tenure of a deal. The above functionalities can be achieved using the following service operations.
-
User should be able to increase the commitment amount of the existing deal arrangement.
-
User should be able to decrease the commitment amount of the existing deal arrangement
-
Deal tenure can be increased or decreased
-
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
-
Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.
-
To increase the drawdown commitment for a given arrangement
-
To decrease the drawdown commitment for a given arrangement
Block or Unblock Commitment and Term
The deal commitment term can be blocked or unblocked based on the customer's request after deal creation for a particular period.
-
Existing deal level commitment term is blocked
-
Existing deal level commitment term is unblocked
-
There could be adverse credit rating of the customer as part of the periodic review and bank would like to restrict further credit exposure. In such cases when the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.
-
There could be adverse credit rating of the customer as part of the periodic review and bank would have restricted further credit exposure and stipulated some mitigants to be fulfilled by customer based on which the restrictions on credit exposure can be lifted. This API is used to unblock the facility commitment.
Update Deal Limit
You can update the credit limit of the customers with information like the sanctioned amount, expiry date, and review frequency of the limit.
-
Allows 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)
Update Pricing Grid
You can change the pricing grid fee or margin ratchet that is defined in the product conditions.
-
Update fee ratchet for a given facility or deal arrangement
-
Update margin ratchet details for principal Interest, penal interest and commission at deal level
-
Update pricing grid margin for principal & penal interest at drawdown level
Update Charge Definitions
Charges can be in the form of admin or new arrangements or withdrawal fees. Changing these fees defined at the product condition level refers to the updation of charge definitions.
Change Admin Fee
PUTUpdate administrative fee collected for the deal
-
It is a common fee charged by lenders when you apply for a loan, it covers the costs of processing your application, including things like administrative costs, credit assessment, loan set-up and document preparation etc.
Closure
The deals are closed after the facilities under a deal are closed.
Closure of Deal
PUTPerform the full credit agreement (facility) cancellation
-
Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.
-
Cancellation of offer drawdown for the required customer.
-
Retrieves the payoff details of a loan
Update Participant
You can update the participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details, and trading details.
-
Update participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details and trading details.
Manage Schedule
Below are the service operations related to manage and retrieve schedule details.
-
Allow user to change schedule condition in facility level.
Change Schedule
PUTPerform repayment date change for the loan product with details like loan reference, product id , etc.
-
Retrieves the schedule payment information for paid and upcoming installments details
-
Retrieves the schedule payment information for paid and upcoming installments details
Manage Limits and Sublimits
A limit defined for a customer can be updated at the facility level.
-
Allows 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)
-
User should be able to update the sub limits based on the risk criterion. When restrictions and allocations are regulated based on the risk elements, borrower, currency and product (product, product group, and product line).
Update Covenants & Conditions
You can update covenants and conditions for a facility. Covenants are requested on a periodic basis and the conditions are one-time evidence. On non-submission or non-compliance with the evidences, the related consequent activity will be restricted.
-
Performs update of covenants and conditions for a facility. Covenants are requested in periodic basis and the conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted
Capture Merge or Split
You can split a facility into two or more facilities or merge two or more facilities into a single facility.
-
API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans
Update Drawing Details
Drawing conditions are initiated to restrict customers, currency, and products for drawdown with overrides. It is set based on the product line, product group, product, property, currency, attribute, value, and message for drawdown under facility level.
-
Drawing condition are set based on the product line, product group, product, property, currency, attribute, value, message for drawdown under facility level.
-
Drawing rules such as borrower, currency, product and product group are defned for drawdown under facility level.
Update Account Details & Settlement Instructions
You can update the details related to the settlement and account holder.
-
Links a direct debit to an existing facility
-
Update the account conditions of the loan such as alternate references, posting restrictions, etc
-
Perform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.
-
Perform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.
Balance Maintenance
Balance Maintenance involves managing financial accounts and ensuring that the balances, bills, and debts associated with those accounts are properly maintained and reconciled.
-
Bill balances such as commitment balance, principal or interest or charge amount of facility should be adjusted
-
Perform the write off of all the balances and bills of a loan. Bank calls for the write off of a loan borrowed by a defaulter when the chances of loan recovery are almost zero and its assets are non-performing.
-
Bill balances such as commitment balance, principal or interest or charge amount of facility should be adjusted
-
Perform a write off of the balances and bills such as principal or interest or charge amount for the unpaid loans
-
Perform a write off of the balances such as principal or interest or charge amount for the unpaid loans
Write Off Bills
PUTPerform a write off of the bills such as interest or charge amount for the unpaid loans
Change Exchange Rate
You can update the exchange rate when there is a cross-currency involved and by considering facilities and drawings in different currencies.
-
Given the scenario, when there is a cross currency involved considering facility and drawings in different currencies, exchange rate is applicable and the same is updated using the exchange rate functionality. Exchange rate property class is to define the Exchange Rate (FX), rate tolerance and prior days, advance FX fix activity, and so on to support the advance FX fixing requirement. Drawings created other than the facility currency, the exchange rate defined under the exchange rate property should be applied. User should be able to retrieve the exchange rate details updated with this API.
Add or Remove Account Holders
You can opt to be a single account holder or multiple holders (joint names) while borrowing a loan from a bank. The latter option usually opts when you pool your income, making your loan eligibility higher, or for claiming tax benefits.
Change Customer
PUTUpdates the customer for the given loan contract
Payment Holiday
You can skip the periodic repayments for your active loans, as agreed in advance by both the lender and borrower. This feature is convenient when customers face economic crises due to individual or abnormal scenarios like COVID. All aspects of payment holidays are controlled by the bank, in agreement with the customer, and can be applied to any outstanding loan(s) of a customer.
-
Initiate update payment holiday activity for a small business loan
-
Simulate update payment holiday activity for a small business loan
-
Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount
Posting Restriction
-
Update the account conditions of the loan such as alternate references, posting restrictions, etc
Manage Interest
You can update the interest conditions of the loan such as interest rate, spread, margin, and so on.
-
Update the interest conditions of the loan such as interest rate, spread, margin etc
-
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
Loan Evidences
Loan evidence refers to the documentation or supporting materials that provide proof of the existence, terms, and conditions of a loan agreement. These documents serve as tangible evidence of the loan transaction and are crucial for record-keeping, legal purposes, and tracking loan-related information.
-
Performs update of covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted
-
Captures and accepts the Annual Financial Statement details like Debt Equity ratio, profit or loss and turnover of the company
-
Captures and accepts the incorporation certificate details like entity name, type, incorporation date
-
Captures and accepts the Quarterly Financial Statement details like Debt Equity ratio, profit or loss and turnover of the company
-
Retrieves the covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted
Update Evidences
PUTPerforms update of covenants and conditions for a loan account. Covenants are requested in periodic basis and the conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted
Change Product
You can change a loan from one product to another like changing one loan product to another loan product.
Change Product
PUTChange loan from one product to another such as changing one loan product to another loan product
Charge Off
Borrowers can default on their payments due to economic or other personal crises. Under these circumstances, a bank may deem certain receivable amounts on the loan arrangement to be charged off. A charge off can be for the overdue amounts (partial) or the entire loan amount. Customers are not aware of a charge off and bills are generated as usual. However, the charged off balances are held in a separate account on the banks books (shadow balances).
Charge Off
PUTExecute loan charge-off activity to charge-off account balance only
-
Retrieves the charge off balances of an arrangement account
Migration
Migration on loans involves transferring loan contracts, including contract details, bills (IDs, properties, amounts), and balance specifics.
Migrate Loans
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.
Migrate Bills
PUTCaptures 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
Migrate Balnaces
PUTCaptures 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.
Deal Information
Deal Information provides details like the customer owning the deal, deals that have been authorized, facilities that have been created under a deal, and so on.
-
Retrieves the corporate deal details.
-
Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.
Fetch Facilities
GETRetrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.
-
Retrieves the corporate facility details
-
Retrieves the fee and margin ratchet details pertaining to deal, facility or drawdown
-
Retrieves the charge details associated at facility and drawdown level
-
Retrieve sublimits details for the specific facility arrangement
Facility Information
Facility Information provides details about a facility like customers related to a facility, drawings that are created under a particular facility, payment schedule of a facility, and so on.
-
Retrieves financial information of the arrangement such as commitment utilized, and non-financial information such as facility start date and end date, along with customer information.
-
Retrieves the drawings under a facility
-
Retrieves the list of available products for credit agreements.
-
Retrieves the consolidated balances for a facility arrangement
-
Retrieves the parent facility for a drawing
-
Retrieves the corporate facility details
-
Retrieves the list of loans that are getting rolled over arrangementId, accountId, customerId, product name, currency, amount, value date, rollover date.
-
Retrieves the commitment schedule of a facility
-
Retrieves the available drawing products under the facility
-
Retrieves the financial summary for a facility arrangement
-
Retrieve participant details for the specific facility arrangement
Fetch Sub limits
GETRetrieve sublimits details for the specific facility arrangement
-
Retrieves the payment schedule of facility and its drawings
Loan Information
This section describes the collection of service operations that provide an overview of financial and non-financial transactions over the lifecycle of the loan.
-
Retrieves the details of the given loan
-
Retrieves the activity log of an account
-
Retrieves the list of loans associated with a customer
-
Retrieves loan details
-
Retrieves the status of a loan
-
Retrieves the statement frequency of an account
Reporting Metrics
This topic explains the service operations and their APIs involved in retrieving the metrics of various loan types.
-
Retrieves the loan details of an account
Approved Loans
GETRetrieves the list of approved accounts created from the loan products
Offer Loans
GETRetrieves the list of simulated accounts created under the given lending product line
Closed Loans
GETRetrieves the list of closed or matured accounts for a given lending product line
Pending Loans
GETRetrieves the list of accounts in hold status for the given lending product
Unapproved Loans
GETRetrieves the list of unapproved accounts for the given loan product
Drawdown Information
This service helps you to fetch drawdown related information.
-
Retrieves the balance details such as commitment balances, utilized balances.
-
Retrieves the past dues and overdues for a drawing
-
Retrieves the list of loans that are getting rolled over arrangementId, accountId, customerId, product name, currency, amount, value date, rollover date.
-
Drawing rules such as borrower, currency, product and product group are defned for drawdown under facility level.
-
Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.
-
Retrieves the corporate drawing details
Repayment Information
This service helps you to fetch repayment related information.
-
Retrieves the information of movements on a credit line such as transaction reference, transaction amount, transaction currency, limit id 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
-
Retrieves the repayment schedule details for an arrangement with simulation reference number
-
Retrieves the schedule payment information for paid and upcoming installments details
Product Information
This service helps you to fetch product related information.
-
Retrieves all the products available in the catalogue with details such as product,productline and productgroup details
-
Retrieves the catalogued conditions of a given product
Fees & 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 fetch the simulation details of the contract based on the selection criteria. It returns the bill details of the loan.
-
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
Syndicated Loan
Syndicated or club loans are substantial credit facilities provided by a group of lenders to a single borrower. Below are the service operations for creating syndicated loan arrangements.
-
Creates a club facility with facility details along with the details of participating lenders
-
Creates a club drawing arrangement with drawdown details along with the details of participating lenders
-
Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings
Transfer Risk Share
POSTCreates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution
-
Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan
-
Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution
-
Retrieves club facilities, drawings and deal
Secondary Loan Trading
Secondary Loan Trading involves the trade of syndicated loans in the secondary loan market. Below are the various service operations involved to create and maintain the various types of trade products.
Create a Trade
POSTCreate a trade for a syndicated loan as initially agreed upon between counterparties.
Accept Trade
POSTConfirm the trade when all the parties involved agreed the terms and conditions of the trade.
Update Trade
POSTUpdate additional details in trade.
Update Consent
POSTUpdate borrower consent for trade
Update Commitment
POSTUpdate the trade due to changes in commitment amount being traded.
Approve Trade
POSTFinalize the trade to verify all necessary details are available.
Show Pricing Letter
POSTIssue pricing letter to the counter party for a final settlement amount.
Calculate a Trade
POSTSettle the trade in bank books.
Cancel Trade
POSTCancel the trade in bank books.
Update Charges
PUTAmend charges already authorized in the trade
Fetch Charges
GETView all the charge details for a given trade.
-
View all the trade products