Table of Contents

• About the REST APIs
• All REST Endpoints

Tasks

• Cash Concentration Services
  • Sweep Instruction API
    • Adds a new instruction
    • Update an existing instruction
  • Sweep Products API
    • Get all valid sweep products
    • Retrieves the sweep products by ID
• Charge Services
  • Charge Definition API
    • Get all valid charge definition
  • Charge Inquiry API
    • Charges Inquiry
• Common Core Services
  • Account API
    • Adds a new core accounts
    • Close the core accounts by given customer account number
    • Reopen the core accounts by given customer account number
    • Retrieves the core accounts by providing array of account numbers
    • Update an existing core accounts
  • BIC Directory API
    • Adds a new BIC directorys
    • Close the BIC directory by given ID
    • Get all valid BIC directorys
    • Reopen the BIC directory by given ID
    • Update an existing BIC directory
  • Branch API
    • Adds a new core banks
    • Adds a new core branches
    • Adds a new local holidays
    • Close the core banks by given ID
    • Close the core branches by given ID
    • Close the local holidays by given ID
    • Reopen the core banks by given ID
    • Reopen the core branches by given ID
    • Reopen the local holidays by given ID
    • Update an existing core banks
    • Update an existing core branches
    • Update an existing rule
  • Branch EOD API
    • Get EOD process status of a given branch
  • Country Code API
    • Adds a new country code
    • Adds a new host code
    • Adds a new language code
    • Close the country codes by given ID
    • Close the host codes by given ID
    • Close the language code service by given ID
    • Reopen the country codes by given ID
    • Reopen the host codes by given ID
    • Reopen the language code service by given ID
    • Update an existing host code
    • Update an existing rule
    • Update an existing rule
  • Currency API
    • Adds a new currency definitions
    • Adds a new currency holiday calendars
    • Adds a new currency pairs
    • Adds a new currency rate types.
    • Adds a new rates
    • Close the currency definitions by given ID
    • Close the currency holiday calendars by given ID
    • Close the currency pairs by given ID
    • Close the currency rate types by given ID
    • Close the rates by given ID
    • Reopen the currency definitions by given ID
    • Reopen the currency holiday calendars by given ID
    • Reopen the currency rate types by given ID
    • Reopen the currencypairs by given ID
    • Reopen the rates by given ID
    • Update an existing rule
    • Update an existing rule
    • Update an existing rule
    • Update an existing rule.
    • Update an existing rule.
  • Customer API
    • Adds a new core customers
    • Close the core customers by given ID
    • Reopen the core customers by given ID
    • Retrieves the core customers by providing array of customer number
    • Update an existing core customers
  • ECA System API
    • Adds a new ECA system
    • Close the ECA systems by given ID
    • Get all valid ECA systems
    • Reopen the ECA systems by given ID
    • Update an existing ECA systems
  • External Chart Accounts API
    • Adds a new external chart accounts
    • Close the external chart accounts by given ID
    • Reopen the external chart accounts by given ID.
    • Update an existing rule
  • External Virtual Account API
    • Adds the new core virtual accounts
    • Close the core virtual account by given Natural Key
    • Get all valid core virtual accounts
    • Modifies the core virtual accounts for a natural key
    • Reopen the core virtual account by given Natural Key
    • Retrieves the core virtual accounts by natural key
  • External Virtual Account Structured Address API
    • Adds a new structured address service
    • Close the structured address service by given ID
    • Get all valid structured address service
    • Reopen the structured address service by given ID
    • Retrieves the structured address service by ID
    • Update an existing structured address service
  • Transaction Code API
    • Adds a new core transaction codes
    • Close the core transaction codes by given ID
    • Reopen the core transaction codes by given ID
    • Update an existing core transaction codes
  • Upload Source Preference API
    • Adds a new upload source preferences
    • Adds a new upload sources
    • Close the upload source preferences by given ID
    • Close the upload sources by given ID
    • Get all valid upload source preferences.
    • Get all valid upload sources.
    • Reopen the upload source preferences by given ID.
    • Reopen the upload sources by given ID
    • Update an existing rule
    • Update an existing rule
• Dashboard Services
  • Account Dashboard API
    • Persists Accounts
    • Persists Accounts
  • Account Map API
    • Retrieves the list of total account map
  • Currency Balance API
    • Retrieves the Currency Balance by ID
  • Currency Liability API
    • Retrieves the list of existing currency liability
  • Customer Account Balance API
    • Persists Balance of Accounts
  • Effective Balance API
    • Retrieves the list of total effective balances
  • Event Dashboard API
    • Adds a new event
    • Delete a event
    • Modify a event
    • Retrieves the event by ID
    • Retrieves the list of existing events based on log Type
  • Interest Details API
    • Adds a new Interest Details
    • Retrieves the list of existing Interest Details
  • Investment Details API
    • Adds a new Investment Details
    • Retrieves the list of total investment details
  • RM Dashboard API
    • Retrieves the data for RM dashboard
  • Top Cross Border Sweeps API
    • Adds a new Top Cross Border Sweep
    • Retrieves the list of existing cross border sweeps
  • Top Customer Sweeps API
    • Retrieves the list of existing Customer Sweeps
  • Top Customers Balance API
    • Retrieves the list of existing Customer Balance
• ICL Services
  • ICL Customer API
    • Adds a new customer
    • Authorize the customer by given ID
    • Checks the lend limit availability between a pair of customers
    • Close the customer by given ID
    • Deletes the customer identified by given ID
    • Get all valid customer
    • Reopen the customer by given ID
    • Retrieves the customer by ID
    • Retrives the customer by given ID
    • Retrives the customer by given ID
    • Update an existing customer
    • Update lend limit of a customer identified by given ID
  • Loan API
    • Adds a new loan
    • Get all valid loan
    • Get pending loans for given customers
    • initiate loan settlement
    • Record payment on an existing loan
    • Reject an existing loan
    • Retrieves the loan by ID
    • Update an existing loan
    • Update existing loan status
    • Update sweep log ID
  • Loan Transaction API
    • Adds a new new loan
    • Get all valid trx of an existing loan
• Integration Services
  • Balance Fetch Integration API
    • Add a new balances
    • Update a balance
  • Event API
    • Add a new event Logs
    • Get all events
    • Publish all events
  • External System Log API
    • Get all valid external System Log
    • Retrieves the external System Log by ID
    • Update Transaction hand Off Status
  • External System Setup API
    • Adds a new external system setup
    • Authorize the external system setup by given ID
    • Close the external system setup by given ID
    • Deletes the external system setup identified by given ID
    • Get all valid external system setup
    • Get all valid external system setup details
    • Get all valid external system setup where DDA is true
    • reopen the external system setup by given ID
    • Retrieves the external system setup by ID
    • Retrives the external system setup by given ID
    • Retrives the external system setup by given ID
    • Update an existing external system setup
  • Interface API
    • Get all balances
  • Payment Interface API
    • Adds a new payment Interface Service
    • Update an existing payment Interface Service
  • Pre EOD Check API
    • Get all valid count of pre EOD Check records
    • Responds whether the branch has Pending Maintenances for Authorization
    • To get Unauthorized records
  • Transaction Log API
    • Adds a new post-HandOff Transaction
    • Adds a new transaction Log
    • Get all valid transaction Log
    • Process Pending Sweeps
• Interest Input Services
  • Account and Product API
    • Create customer role to head mapping
    • Create IC group-external group mapping
    • Create IC group-product mapping
    • Delete customer role to head mapping
    • Get account role
    • Get all rate Codes
    • Get customer role to head mapping
    • Get for prodUdeList
    • Get IC account group
    • Get IC group product
    • Get ICTB entries history
    • Modify customer role to head mapping
    • Query IC Entries
  • External SDE API
    • Save External sSDE values
  • Rate and Account API
    • Account close pre-process
    • Accrual liquidation details
    • close account
    • Get Accured Amount
    • Get Accured Amount Web API
    • Get all rate Codes
    • Get for general Conditions UDE Value
    • Get for special Condition Ude Value
    • Get VD Balance
    • Modify IC Accounts
    • Save Account Product and Account Charge Slab
    • Save and Authorize IC Accounts
    • Save and Authorize IC Other Balance
    • Save UDE value
    • Save VD Balance
    • Special condition UDE value
• Maintenance Services
  • Account Maintenance API
    • Adds a new account
    • Close the account by given ID
    • Get all valid account
    • Gets the list of virtual and real accounts
    • Reopen the account by given ID
    • Retrieves the account by ID
    • Update an existing account
  • Application Parameters API
    • Adds a new application parameters
    • Authorize the application parameters by given ID
    • Close the application parameters by given ID
    • Deletes the application parameters identified by given ID
    • Get all valid application parameters
    • Reopen the application parameters by given ID
    • Retrieves the application parameters by ID
    • Retrives the application parameters by given ID
    • Retrives the application parameters by given ID
    • Update an existing application parameters
  • Bank Parameters Maintenance API
    • Adds a new bank
    • Update an existing bank
  • Branch Parameters Maintenance API
    • Adds a new branch
    • Update an existing branch
  • Country Parameters API
    • Adds a new country
    • Update an existing country
  • Currency Cutoff API
    • Adds a new ccycutoff
    • Update an existing ccycutoff
  • Currency Parameters API
    • Adds a new currency
    • Update an existing currency
  • Customer Maintenance API
    • Adds a new customer
    • Close the account by given ID
    • Reopen the account by given ID
    • Retrieves the account by ID
    • Update an existing customer
  • Event Maintenance API
    • Adds a new event
    • Authorize the event by given ID
    • Close the event by given ID
    • Deletes the event identified by given ID
    • Get all valid event
    • Reopen the event by given ID
    • Retrieves the event by ID
    • Retrives the event by given event code
    • Update an existing event
  • Frequency API
    • Adds a new frequency
    • Authorize the frequency by given ID
    • Close the frequency by given ID
    • Deletes the frequency identified by given ID
    • Get all valid frequency
    • Reopen the frequency by given ID
    • Retrieves the frequency by ID
    • Retrives the frequency by given ID
    • Retrives the frequency by given ID
    • Update an existing frequency
  • Instruction API
    • Adds a new instruction
    • Authorize the instruction by given ID
    • Close the instruction by given ID
    • Deletes the instruction identified by given ID
    • Get all valid instruction
    • Reopen the instruction by given ID
    • Retrieves the instruction by ID
    • Retrives the instruction by given ID
    • Retrives the instruction by given ID
    • Update an existing instruction
  • Interest Account Group API
    • Adds a new interest account group
    • Authorize the interest account group by given ID
    • Close the interest account group by given ID
    • Deletes the interest account group identified by given ID
    • Get all valid interest account group
    • Reopen the interest account group by given ID
    • Retrieves the interest account group by ID
    • Retrives the interest account group by given ID
    • Retrives the interest account group by given ID
    • Update an existing interest account group
  • Message Type API
    • Get all valid message types
  • RM Linkage API
    • Adds a new RM linkage
    • Authorize the RM linkage by given ID
    • Close the RM linkage by given ID
    • Deletes the RM linkage identified by given ID
    • Get all valid RM linkage
    • Get all valid RM linkage customer
    • Reopen the RM linkage by given ID
    • Retrieves the RM linkage by ID
    • Retrives the RM linkage by given ID
    • Retrives the RM linkage by given ID
    • Update an existing RM linkage
  • UnAuthorized Records API
    • Get all valid UnAuthorized Records
  • World Cities API
    • Get all valid world cities
    • Retrieves the city by Country
  • World Time Zone API
    • Get all valid world timezones
    • Retrieves the timezones by Country Code
• Messaging Services
  • Account Parameters API
    • Adds a new account
    • Adds a new account
    • Adds a new multiple accounts
    • Authorize the account by given ID
    • Close the account by given ID
    • Deletes the account identified by given ID
    • Get all valid account
    • Get List of Accounts for the given customer collection
    • Gets the list of external accounts
    • Gets the list of internal accounts
    • Reopen the account by given ID
    • Retrieves the account by ID
    • Retrives the account by given ID
    • Retrives the account by given ID
    • Update account
    • Update an existing account
    • Update an existing account
    • Update Balance for given account
  • Balance Fetch API
    • Add a new balances
    • Get all balances
    • Get all valid value dated balances for the specified account
    • Retrieves the accoubt by Value Date
    • Retrieves the balance by ID
    • Retrieves the balance by ID
    • Retrieves the balance by ID
    • Update a balance
  • Bank Parameters API
    • Adds a new bank
    • Authorize the bank by given ID
    • Close the bank by given ID
    • Deletes the bank identified by given ID
    • Get all valid bank
    • Gets the list of external banks
    • Gets the list of internal banks
    • Reopen the bank by given ID
    • Retrieves the bank by ID
    • Retrives the bank by given ID
    • Retrives the bank by given ID
    • Update an existing bank
  • Branch Parameters API
    • Adds a new branch
    • Authorize the branch by given ID
    • Close the branch by given ID
    • Deletes the branch identified by given ID
    • Flips the date of a branch
    • Get all valid BIC Codes
    • Get all valid branch
    • Gets the list of internal or external branches based on bank type
    • Gets the list of internal or external branches based on bank type
    • Reopen the branch by given ID
    • Retrieves the branch by ID
    • Retrieves the external system details by branch code
    • Retrives the branch by given ID
    • Retrives the branch by given ID
    • Update an existing branch
  • External Message API
    • Post MT message
  • External Message Log API
    • Get all MT message log
    • Process hold messages in batch
    • Process pending message
    • Supress Message
  • Form Common Message API
    • Form common DTO message for given XML message
  • Sweep Monitor API
    • Add new data for sweep monitor
• Online Liquidation Services
  • Branch Parameter Liquidation API
    • Get all valid Online Liquidation
    • Liquidate Online
• Pool Services
  • Pool API
    • Fetch pool log for structure
    • Fetch ratio method details for branch
    • Invoking pool batch for branch
    • Invoking pool batch for branch
    • Invoking pool batch for structure
    • Simulate pool for a structure
  • Pool Reallocation API
    • Fetch IC history entries
    • Fetch IC history entries for accrual handOff
    • Get all fetch all reallocation details
    • Get all pending reallocation logs
    • Get all valid pool reallocation data
    • Invoking reallocation batch for structure
    • Invoking reallocation batch for structure
    • Invoking withholding tax for structure
    • Invoking withholding tax for structure
    • Process ICL loan interest liquidation
    • Simulate pool reallocation for structure
    • Update an existing reallocation log data
• Report Services
  • Exception Report API
    • Adds a new exception report data
    • Get exception Report
  • Interest Accrual Report API
    • Get all valid interest accrual report
  • Interest Paid Report API
    • Adds a new reallocation details
    • Adds a new reallocation log
    • Get all valid interest paid report
    • Update reallocation details
  • Interest Paid Report APIt
    • Adds a new ICTB entries history
  • Interest Reallocation Report API
    • Get all valid interest reallocation report
  • QC Interface Report API
    • Adds a new QC interface report
  • Simulation Report API
    • Generate pool report
    • Generate sweep report
  • Structure Created Report API
    • Adds a new structure created report
  • Structure Details Report API
    • Adds a new structure details report
  • Sweep Structure Report API
    • Get all valid reports
  • Sweep Summary Report API
    • Adds a new sweep summary report data
• RTL Services
  • Real Time Liquidity Parameter API
    • Adds a new real time liquidity parameter
    • Authorize the real time liquidity parameter by given ID
    • Close the real time liquidity parameter by given ID
    • Deletes the real time liquidity parameter identified by given ID
    • Get all valid real time liquidity parameter
    • Reopen the real time liquidity parameter by given ID
    • Retrieves the real time liquidity parameter by ID
    • Retrives the real time liquidity parameter by given ID
    • Retrives the real time liquidity parameter by given ID
    • Update an existing real time liquidity parameter
  • Real Time Liquidity Structure API
    • Adds a new real time liquidity structure
    • Authorize the real time liquidity structure by given ID
    • Close the real time liquidity structure by given ID
    • Deletes the real time liquidity structure identified by given ID
    • Get all valid real time liquidity structure
    • Reopen the real time liquidity structure by given ID
    • Retrieves the real time liquidity structure by ID
    • Retrieves the real time liquidity structure by ID
    • Retrieves the real time liquidity structure by ID
    • Retrives the real time liquidity structure by given ID
    • Retrives the real time liquidity structure by given ID
    • Update an existing real time liquidity structure
  • Real Time Liquidity Transaction Monitor API
    • Get all valid RTL sublimit transactions
    • Get all valid RTL transaction
    • Get sublimit details on a structure
    • Initiate RTL transaction
    • Modify all valid RTL transaction
    • Post RTL transaction
    • Undo RTL transaction
• Structure Services
  • Interest Enhancement API
    • Adds a new interest enhancement
    • Authorize the interest enhancement by given ID
    • Close the interest enhancement by given ID
    • Deletes the interest enhancement identified by given ID.
    • Get all valid interest enhancement
    • reopen the interest enhancement by given ID
    • Retrieves the IE structure ID
    • Retrieves the interest enhancement by ID
    • Retrives the interest enhancement by given ID
    • Retrives the interest enhancement by given ID
    • Update an existing interest enhancement
  • Structure Maintenance API
    • Adds a new structure from external system
    • Adds a new structure from simulated structure
    • Export an a structure
    • Fetch all the accounts of a structure by given ID
    • Fetch Structure Account Priority's for the given account
    • Fetch Structure Account Priority's for the given account
    • Fetch Structure Account Priority's for the given accounts
    • For a given intruction ID or frequency, validates whether there are open structures
    • Get all structure that are going to expire within n days
    • Get all valid simulation structure
    • Get structure logs to view, authorize or reject
    • Modifies a structure from external system
    • Reject the structure by given ID
    • Retrieves active VA count for the input real customer with structure
    • Retrieves the BOD structure master ID by header branch code
    • Retrieves the reallocation structure details by header branch code
    • Retrieves the structure by ID
    • Retrieves the structure for EOD by header branch code
    • Retrieves the structure for pool by header branch code
    • Retrieves the structure ID
    • Retrieves the structure ID and simulation ID
    • Retrieves the structure Master ID by header branch code reverse sweep
    • Retrieves the structure master ID by next run date
    • Retrieves the structure master ID by next run date for reverse sweep
    • Retrieves the structure master ID by next run date reverse
    • Update an existing structure with validation
    • Update last successful sweep for given structure
    • Update next run date for given structure
    • Update structure status of existing structures
    • Validates a new structure
• Sweep Services
  • Contribution API
    • Add new data for contribution
    • Get all valid contribution
    • Get all valid contribution
    • Get all valid contribution
    • Get all valid contribution
    • Get all valid contribution
    • Retrieves minimum contribution value date for given structure
    • Update an existing contribution data
  • IC Input API
    • Save and authorize VD balance
    • Save and authprize IC account
  • Reverse Sweep API
    • Run reverse sweep service for a structure
    • Run reverse sweep service for a structure
    • Run reverse sweep service for accounts
    • Run sweep service for a structure
  • Reverse Sweep Monitor API
    • Get all valid reverse sweep monitor
  • Scheduled Sweeps API
    • Adds a new batch
    • Adds a new scheduled sweeps
    • Get all valid batch
    • Retrieves the list of existing scheduled sweeps
    • Update status for batch data
  • Sweep API
    • Authorize the structure by given ID
    • Execute sweep for a structure
    • Get all valid account pair for authorize
    • Get all valid adhoc structure sweep structure
    • Get all valid structure for authorize
    • Get all valid structure for authorize
    • Initiate sweep structure
    • Reject the structure by given ID
    • Retrieves all unauthorized structures
    • Retrieves the structure by ID
    • Run sweep service for a structure
    • Run sweep service for a structure
    • Run sweep service for a structure
    • Run sweep service for a structure
    • Simulate sweep service for a structure
  • Sweep Master API
    • Add new data for sweep master
    • Get all valid sweep master data
    • Update an existing sweep master data
  • Sweep Monitor API
    • Add new data for sweep monitor.
    • Authorize sweep status.
    • For a given account, check sweep in-progress for that day
    • For a given branch and branch date, validates whether sweep log contains pending sweeps.
    • Get all pending sweep logs.
    • Get all valid sweep monitor by external transaction number.
    • Get all valid sweep monitor.
    • Retrieves Sweep count for the input real customer with structure
    • Update an existing sweep log data.
    • Update an existing sweep log data.
    • Update the sweep status.
  • Sweep Reallocation API
    • Get all valid sweep reallocation data
  • System Account API
    • Create new system account
    • Get all valid system accounts
    • Get valid system accounts for passed account pair
    • Record reallocation in system account
    • Record repayment in system account
    • Update status of system account