REST API for Oracle Banking Virtual Account Management

All REST Endpoints

Account Services/Account Balance Service

This service is used to perform the Virtual Account Balance Operations.

Get the balance: Method: get
Path: /service/balance
Get the balance for all the virtual accounts of a structure: Method: get
Path: /service/structureaccountbalances
Get the current balance of virtual account: Method: get
Path: /service/balance/{virtualAccountNo}

Account Services/Account Closure Service

This service is used to create Virtual Account Closure for Virtual Entity.

Creates a new transaction request for Virtual Account Closure: Method: post
Path: /service/accountclosure
Request to get details of the Virtual Account Closure: Method: get
Path: /service/accountclosure/{sourceReferenceNo}

Account Services/Account File Service

This service is used to create Corporate Specific Virtual Account products. These products are further used to create virtual accounts. Product level preferences must be enabled before enabling the preference for account.

Adds a new Ack File to obvam: Method: post
Path: /service/account/h2hAckFile
Adds a new Ack File to obvam: Method: post
Path: /service/account/h2hAckFileAsync
Adds a new data segment details: Method: post
Path: /service/account/parsefile
Adds a new data segment details: Method: post
Path: /service/account/parsefileAsync
Adds a new Handoff File to obvam: Method: post
Path: /service/account/handoffAsync
Adds a new Handoff File to obvam: Method: post
Path: /service/account/handoffProcess

Account Services/Account Input Service

This service is used to create Virtual Account for Virtual Entity. Virtual Account details such as IBAN and Debit/Credit restrictions, Interest, Overdraft, Real Account Linkage preferences are captured.

Adds a new accounts: Method: post
Path: /service/accounts
Fetches the details of the input Virtual Account.: Method: get
Path: /service/accounts/{virtualAccountNo}
Get all Account Currencies for the given account product: Method: get
Path: /service/accounts/ccysforaccountproduct
Get all valid accounts: Method: get
Path: /service/accounts
Get all valid accounts for closure: Method: get
Path: /service/accounts/virtualaccountsforclosure
Get all valid accounts for structure linkage: Method: get
Path: /service/accounts/getVAForStructure
Get all valid virtual accounts allowed as transfer account: Method: get
Path: /service/accounts/virtualaccountsfortransfer/{closureVirAcc}
Get virtual accounts which are either directly linked to real account or the header accounts in a structure -that can take part in linkage: Method: get
Path: /service/vaforlinkage
Reopen account for the given virtual account number: Method: patch
Path: /service/accounts/{virtualAccountNo}/reopen
Retrives the list of Accounts with Balance and Structure Code: Method: get
Path: /service/accounts/accountswithbalandstrcode
Update an existing accounts: Method: put
Path: /service/accounts/{virtualAccountNo}

Account Services/Account Product Service

This service can create Corporate Specific Virtual Account products. These products are further used to create virtual accounts. Product level preferences must be enabled before enabling the preference for account.

Gets all valid account products: Method: get
Path: /service/accountproducts
Gets all valid account products that have the given Limit Codes attached: Method: post
Path: /service/accountproducts/getByLimitCodes

Account Services/Account Range Service

This service is used for fetching the necessary details of Corporate Specific Account Number Range.

Get all valid Account Range: Method: get
Path: /service/accountrange

Account Services/Account Structure Service

This service is used to create Virtual Account Structure. Through this service, Virtual accounts can be mapped to a real account and the structure can be linked to various virtual accounts as per the customer requirement.

Adds a new account structures: Method: post
Path: /service/accountstructures
Close the Account Structure by given Natural Key: Method: patch
Path: /service/accountstructures/{virtualMainAcc}/close
Fetches the list of linked child account's Number by given Virtual Account Number: Method: get
Path: /service/accountstructures/linkedChildAccounts/{virtualAccountNo}
Get all valid account structures: Method: get
Path: /service/accountstructures
Get all valid account structures by customer: Method: get
Path: /service/accountstructures/getByCustomer
Linking or Delinking a virtual account in the existing Account Structure: Method: put
Path: /service/accountstructures/modifystructure
Retrieves the account structures by ID: Method: get
Path: /service/accountstructures/download
Retrieves the account structures by virtualMainAcc with account balances: Method: get
Path: /service/accountstructures/{virtualMainAcc}/withAccountBalance
Retrieves the account structures by virtualMainAcc with account balances and child count: Method: get
Path: /service/accountstructures/{virtualMainAcc}/viewaccountstructure
Returns all VA that is part of the given customer and structure code: Method: get
Path: /service/accountstructures/viewvainstructure
Update an existing account structures: Method: put
Path: /service/accountstructures/{virtualMainAcc}

Account Services/Account Transaction Restriction Service

This service is used to perform the Account level transaction restrictions.

Add/update the account transaction restriction: Method: post
Path: /service/acctxnrestriction
Close the account transaction restriction: Method: patch
Path: /service/acctxnrestriction/close

Account Services/Account Transaction Utilization Service

This service is used to retrieve the Transaction Utilization for a given Virtual Account

Gets the Transaction Utilization for a Virtual Account: Method: get
Path: /service/accountTxnUtil

Account Services/Branch Parameters Service

This services is used to maintain the parameters that are controlled at branch. Oracle Banking Virtual Account Management maintains account and IBAN parameters for a branch. It has various parameters to validate the generated account number such as account mask, start and end account number for auto generation, and to validate IBAN format mask for BBAN format mask and data type.

Get all valid account branch parameters: Method: get
Path: /service/accountbranchparameters

Account Services/Credit Limit Linkage Service

This service is used to link Internal credit limit to a virtual account. Limit amount can either be mentioned in amount or percentage. During balance calculation, this maintenance will also be included to arrive at effective available balance.

Adds a new credit limit linkage: Method: post
Path: /service/creditlimitlinkage
Close the credit limit linkage by given ID: Method: patch
Path: /service/creditlimitlinkage/{lineId}/{virtualAccountNo}/close
Get all valid credit limit linkage: Method: get
Path: /service/creditlimitlinkage
Update an existing credit limit linkage: Method: put
Path: /service/creditlimitlinkage/{lineId}/{virtualAccountNo}

Account Services/Internal Credit Limit Service

Internal Credit Limit is a facility provided at Real customer level. Through this service, a customer can offer credit line facility to its subsidiaries. A Credit line facility can be linked to multiple virtual accounts that belong to same real customer number.

Adds a new internal credit limit: Method: post
Path: /service/internalcreditlimits
Close the internal credit limit by given ID: Method: patch
Path: /service/internalcreditlimits/{lineId}/close
Get all valid internal credit limit: Method: get
Path: /service/internalcreditlimits
Update an existing internal credit limits: Method: put
Path: /service/internalcreditlimits/{lineId}

Account Services/Line Limit Utilization Service

This Service is used to track internal credit limit utilization and de-utilization for a virtual account at both contract/transaction and account level. Also this provides the maximum available line amount for a given Line ID.

Get Credit Limit utilization details at Account level for the given Real Customer Number and Line ID: Method: get
Path: /service/lineAccountUtilizationDetails
Get Credit Limit utilization details for the given Real Customer Number and Line ID: Method: get
Path: /service/lineUtilizationDetails

Account Services/Sweep Eligible and Value Dated Balance Service

This service is used for Sweep eligible balance and Value Dated Balance Operations.

Service API that gets valid value dated balances details and sweep eligible balance for the specified virtual account and value date: Method: post
Path: /service/sweepandvaluedatedbalance

Account Services/Transaction Code Preference Service

This service is used for Transaction code maintenance service operations.

Close the transaction code maintainance by given transaction code: Method: patch
Path: /service/txncodemaint/{txnCode}/close
Create Transaction Code Maintainance details: Method: post
Path: /service/txncodemaint
Get all the maintainance for the specified transaction code: Method: get
Path: /service/txncodemaint
Reopen the transaction code maintainance by given transaction code: Method: patch
Path: /service/txncodemaint/{txnCode}/reopen
Update an existing Transaction Code: Method: put
Path: /service/txncodemaint/{txnCode}

Account Services/Uncollected Amount Manual Release Service

This service is used for releasing uncollected amount.

API to authorize the manually released uncollected amount: Method: patch
Path: /service/uncollectedamt/{id}/approve
API to manually release uncollected amount: Method: get
Path: /service/releasedUncollectedAmtTxns/{referenceNo}
Releases uncollected amount manually: Method: post
Path: /service/uncollectedamt
Retrieves the list of manually released uncollected amount transactions: Method: get
Path: /service/releasedUncollectedAmtTxns/getAll
Retrieves the list of manually released uncollected amount transactions by reference number: Method: delete
Path: /service/releasedUncollectedAmtTxns/{referenceNo}
Retrieves the list of uncollected amount transactions: Method: get
Path: /service/uncollectedAmtTxns

Account Services/Value Dated Balance Service

This service is used for Value Dated Balance Operations.

Get all valid value dated balances for the specified virtual account: Method: post
Path: /service/getVDBalance
Service API that Get all valid value dated balances for the specified virtual account: Method: get
Path: /service/getVDBalance

Account Services/Virtual Account Closure Status Service

This Service is used to track the status of Virtual Account Closure Request.

Abort virtual account closure request: Method: patch
Path: /service/vaclosurestatus/{sourceReferenceNo}/{virtualAccountNo}/abort
Get all the Virtual account closure request status records: Method: get
Path: /service/vaclosurestatus
Get the sequence of processes happened as part of virtual account closure: Method: get
Path: /service/vaclosurestatus/process
Retry virtual account closure request: Method: patch
Path: /service/vaclosurestatus/{sourceReferenceNo}/{virtualAccountNo}/retry

Account Services/Virtual Account Sanction Status Service

This Service API is used to handle sanction status for a virtual account

Adds a new record in virtual account sanction status: Method: post
Path: /service/vasanctionstatus
Get Virtual account Sanction status record by account number: Method: get
Path: /service/vasanctionstatus

Charge Services/Charge Definition Service

This service is used to query the charge definition.

Get all valid charge definition: Method: get
Path: /service/chargedefinition

Charge Services/Charge Inquiry Service

This services is used to facilitate the enquiry of all charges associated to a customer within an application based on the selected filters.

Charges Inquiry: Method: get
Path: /service/chargeInquiry

Charge Services/External Charge Calculation Service

This service is used to get charge basis for the given customer.

Fetches Charge Basis for External Charge Calculation: Method: post
Path: /service/externalChgCalculation

Charge Services/External Charge Posting Service

This service is used to facilitate the enquiry of all charges associated to a customer within an application based on the selected filters.

Query charge amount for external posting: Method: post
Path: /service/queryExternalCharge
Update External charge posting status: Method: post
Path: /service/updateExternalChargePosting

Common Core Services/Account Service

This service is used to create Virtual Account for Virtual Entity. Virtual Account Details such as IBAN and Debit/Credit restrictions. Interest, Overdraft, Real Account Linkage Preferences are captured

Adds a new core accounts: Method: post
Path: /service/coreaccounts
Close the core accounts by given custAccountNo: Method: patch
Path: /service/coreaccounts/{custAccountNo}/close
Reopen the core accounts by given custAccountNo: Method: patch
Path: /service/coreaccounts/{custAccountNo}/reopen
Retrieves the core accounts by providing array of account numbers: Method: get
Path: /service/coreaccounts/getAccounts
Update an existing core accounts: Method: put
Path: /service/coreaccounts/{custAccountNo}

Common Core Services/BIC Directory Service

This service defines the Bank Codes so that the bank is identified by SWIFT. BICs are used when it is necessary to identify exactly a party of a transaction and are frequently used to help route payments.

Adds a new bic directory: Method: post
Path: /service/bicdirectorys
Close the bic directory by given ID: Method: patch
Path: /service/bicdirectorys/{bicCode}/close
Get all valid bic directorys: Method: get
Path: /service/bicdirectorys
Reopen the bic directory by given ID: Method: patch
Path: /service/bicdirectorys/{bicCode}/reopen
Update an existing bic directory: Method: put
Path: /service/bicdirectorys/{bicCode}

Common Core Services/Branch EOD Service

This service provides the API for branch EOD Operations

Get EOD process status of a given branch: Method: get
Path: /service/brancheod/{branchCode}/{eodDate}

Common Core Services/Branch Service

This service is used for local holidays Operations.

Adds a new core banks: Method: post
Path: /service/corebanks
Adds a new core branches: Method: post
Path: /service/corebranchs
Adds a new local holidays: Method: post
Path: /service/localholidays
Close the core banks by given ID: Method: patch
Path: /service/corebanks/{bankCode}/close
Close the core branches by given ID: Method: patch
Path: /service/corebranchs/{branchCode}/close
Close the local holidays by given ID: Method: patch
Path: /service/localholidays/{branchCode}/{year}/close
Reopen the core banks by given ID: Method: patch
Path: /service/corebanks/{bankCode}/reopen
Reopen the core branches by given ID: Method: patch
Path: /service/corebranchs/{branchCode}/reopen
Reopen the local holidays by given ID: Method: patch
Path: /service/localholidays/{branchCode}/{year}/reopen
Update an existing core banks: Method: put
Path: /service/corebanks/{bankCode}
Update an existing core branches: Method: put
Path: /service/corebranchs/{branchCode}
Update an existing rule: Method: put
Path: /service/localholidays/{branchCode}/{year}

Common Core Services/Country Code Service

This service is used for country code Operations.

Adds a new country code: Method: post
Path: /service/countrycodes
Adds a new host code: Method: post
Path: /service/hostcodes
Adds a new language code: Method: post
Path: /service/languagecodes
Close the country codes by given ID: Method: patch
Path: /service/countrycodes/{countryCode}/close
Close the host codes by given ID: Method: patch
Path: /service/hostcodes/{hostCode}/close
Close the language code service by given ID: Method: patch
Path: /service/languagecodes/{languageCode}/close
Reopen the country codes by given ID: Method: patch
Path: /service/countrycodes/{countryCode}/reopen
Reopen the host codes by given ID: Method: patch
Path: /service/hostcodes/{hostCode}/reopen
Reopen the language code service by given ID: Method: patch
Path: /service/languagecodes/{languageCode}/reopen
Update an existing host code: Method: put
Path: /service/hostcodes/{hostCode}
Update an existing rule: Method: put
Path: /service/countrycodes/{countryCode}
Update an existing rule: Method: put
Path: /service/languagecodes/{languageCode}

Common Core Services/Currency Service

This service API is used for Currency Operations.

Adds a new currency definitions: Method: post
Path: /service/currencydefinitions
Adds a new currency holiday calendars: Method: post
Path: /service/currencyholidaycalendars
Adds a new currency pairs: Method: post
Path: /service/currencypairs
Adds a new currency rate types: Method: post
Path: /service/currencyratetypes
Adds a new rates: Method: post
Path: /service/rates
Close the currency definitions by given ID: Method: patch
Path: /service/currencydefinitions/{currencyCode}/{maintenanceCountry}/close
Close the currency holiday calendars by given ID: Method: patch
Path: /service/currencyholidaycalendars/{currency}/{year}/close
Close the currency pairs by given ID: Method: patch
Path: /service/currencypairs/{currency1}/{currency2}/{maintenanceCountry}/close
Close the currency rate types by given ID: Method: patch
Path: /service/currencyratetypes/{currencyRateType}/close
Close the rates by given ID: Method: patch
Path: /service/rates/{branchCode}/{currency1}/{currency2}/close
Reopen the currency definitions by given ID: Method: patch
Path: /service/currencydefinitions/{currencyCode}/{maintenanceCountry}/reopen
Reopen the currency holiday calendars by given ID: Method: patch
Path: /service/currencyholidaycalendars/{currency}/{year}/reopen
Reopen the currency pairs by given ID: Method: patch
Path: /service/currencypairs/{currency1}/{currency2}/{maintenanceCountry}/reopen
Reopen the currency rate types by given ID: Method: patch
Path: /service/currencyratetypes/{currencyRateType}/reopen
Reopen the rates by given ID: Method: patch
Path: /service/rates/{branchCode}/{currency1}/{currency2}/reopen
Update an existing currency definitions: Method: put
Path: /service/currencydefinitions/{currencyCode}/{maintenanceCountry}
Update an existing currency holiday calendars: Method: put
Path: /service/currencyholidaycalendars/{currency}/{year}
Update an existing currency pairs: Method: put
Path: /service/currencypairs/{currency1}/{currency2}/{maintenanceCountry}
Update an existing currency rate types: Method: put
Path: /service/currencyratetypes/{currencyRateType}
Update an existing rates: Method: put
Path: /service/rates

Common Core Services/Customers Service

This service is used to maintain the record for external customers.It has the option to create different type and different category for the customers, also it takes the source system and source system customer number as input and maps the source system customer number to a unique customer.

Adds a new corecustomers: Method: post
Path: /service/corecustomers
Close the core customers by given ID: Method: patch
Path: /service/corecustomers/{customerNo}/close
Reopen the core customers by given ID: Method: patch
Path: /service/corecustomers/{customerNo}/reopen
Retrieves the core customers by providing array of customerNos: Method: get
Path: /service/corecustomers
Update an existing core customers: Method: put
Path: /service/corecustomers/{customerNo}

Common Core Services/ECA System Service

This service is used to maintain the External Credit Approval System (ECA System). This field is also referred as Source System which identifies the source of the maintenance (Customer, Account, Branch, Bank, Transaction code etc).

Adds a new eca systems: Method: post
Path: /service/ecasystems
Close the eca systems by given ID: Method: patch
Path: /service/ecasystems/{ecaSystem}/close
Get all valid eca systems: Method: get
Path: /service/ecasystems
Reopen the eca systems by given ID: Method: patch
Path: /service/ecasystems/{ecaSystem}/reopen
Update an existing eca systems: Method: put
Path: /service/ecasystems/{ecaSystem}

Common Core Services/External Chart Accounts Service

This service API is used for external chart accounts Operations.

Adds a new external chart accounts: Method: post
Path: /service/externalchartaccounts
Close the external chart accounts by given ID: Method: patch
Path: /service/externalchartaccounts/{glCode}/close
Reopen the external chart accounts by given ID.: Method: patch
Path: /service/externalchartaccounts/{glCode}/reopen
Update an existing rule: Method: put
Path: /service/externalchartaccounts/{glCode}

Common Core Services/External Virtual Account Service

This service is used to create virtual accounts in plato common core as external virtual accounts. External Virtual Accounts will be populated from OBVAM account service on authorization of new Virtual account.

Adds the new core virtual accounts: Method: post
Path: /service/corevirtualaccounts
Close the core virtual account by given Natural Key: Method: patch
Path: /service/corevirtualaccounts/{virtualAccountNo}/close
Get all valid core virtual accounts: Method: get
Path: /service/corevirtualaccounts
Modifies the core virtual accounts for a natural key: Method: put
Path: /service/corevirtualaccounts/{virtualAccountNo}
Reopen the core virtual account by given Natural Key: Method: patch
Path: /service/corevirtualaccounts/{virtualAccountNo}/reopen
Retrieves the core virtual accounts by natural key: Method: get
Path: /service/corevirtualaccounts/{virtualAccountNo}

Common Core Services/External Virtual Account Structured Address Service

This service is used to maintain structured address for Real Account .

Adds a new structured address service: Method: post
Path: /service/structuredaddressservice
Close the structured address service by given ID: Method: patch
Path: /service/structuredaddressservice/{virtualAccountNo}/close
Get all valid structured address service: Method: get
Path: /service/structuredaddressservice
Reopen the structured address service by given ID: Method: patch
Path: /service/structuredaddressservice/{virtualAccountNo}/reopen
Retrieves the structured address service by ID: Method: get
Path: /service/structuredaddressservice/{virtualAccountNo}
Update an existing structured address service: Method: put
Path: /service/structuredaddressservice/{virtualAccountNo}

Common Core Services/Multi-Currency Account Service

This service is used to maintain multi currency accounts by linking it with sub accounts.

Adds a new Multi-Currency Account linkage: Method: post
Path: /service/multi-currency-accounts/linkage
Close the Multi-Currency Account linkage by given ID: Method: patch
Path: /service/multi-currency-accounts/linkage/{multiCurrencyAccNo}/close
Get all valid Multi-Currency Account linkage: Method: get
Path: /service/multi-currency-accounts/linkage
Reopen the Multi-Currency Account linkage by given ID: Method: patch
Path: /service/multi-currency-accounts/linkage/{multiCurrencyAccNo}/reopen
Update an existing Multi-Currency Account linkage: Method: put
Path: /service/multi-currency-accounts/linkage/{multiCurrencyAccNo}

Common Core Services/Structured Address Service

This service is used to maintain structured address for Real Account.

Adds a new structured address: Method: post
Path: /service/structuredaddress
Close the structured address by given Customer Account Number: Method: patch
Path: /service/structuredaddress/{custAccountNo}/close
Reopen the structured address by given Customer Account Number: Method: patch
Path: /service/structuredaddress/{custAccountNo}/reopen
Retrieves the structured addresses by providing array of account numbers: Method: get
Path: /service/structuredaddress/getStructuredAddresses
Update an existing structured address: Method: put
Path: /service/structuredaddress/{custAccountNo}

Common Core Services/Transaction Code Service

This service is used to create Source Transaction Codes. Transaction codes represents various types of transactions, for example, transfer charges, incoming mail transfer, incoming telex transfer, reserve, incoming clearing transfer etc.

Adds a new core trn codes: Method: post
Path: /service/coretrncodes
Close the core trn codes by given ID: Method: patch
Path: /service/coretrncodes/{trnCode}/close
Reopen the core trn codes by given ID.: Method: patch
Path: /service/coretrncodes/{trnCode}/reopen
Update an existing core trn codes: Method: put
Path: /service/coretrncodes/{trnCode}

Common Core Services/Upload Source Preference Service

This service API is used for upload source preferences Operations

Adds a new upload source preferences: Method: post
Path: /service/uploadsourcepreferences
Adds a new upload sources: Method: post
Path: /service/uploadsources
Close the upload source preferences by given ID: Method: patch
Path: /service/uploadsourcepreferences/{uploadSourceCode}/close
Close the upload sources by given ID: Method: patch
Path: /service/uploadsources/{uploadSourceCode}/close
Get all valid upload source preferences: Method: get
Path: /service/uploadsourcepreferences
Get all valid upload sources: Method: get
Path: /service/uploadsources
Reopen the upload source preferences by given ID: Method: patch
Path: /service/uploadsourcepreferences/{uploadSourceCode}/reopen
Reopen the upload sources by given ID: Method: patch
Path: /service/uploadsources/{uploadSourceCode}/reopen
Update an existing rule: Method: put
Path: /service/uploadsourcepreferences/{uploadSourceCode}
Update an existing rule: Method: put
Path: /service/uploadsources/{uploadSourceCode}

Core Services/Account Facility Service

This service is used for Account Facility Creation and maintenance. This service is also used to define the real customer and its real accounts for which virtual accounts can be created. It has a Real Customer LOV field which has one to many Relation with Real Accounts of that customer.

Get all parameter related to bank and default virtual entity: Method: get
Path: /service/accfcltybankparams/{keyId}
Get all parameter related to sanction check: Method: get
Path: /service/sanctionCheckParameters/{customerNumber}
Get all the valid account facilities: Method: get
Path: /service/accountfacility
Retrieves the account facilities for the Real Customer Number: Method: get
Path: /service/accountfacility/vaenabledaccounts
Retrieves the account facilities for the Real Customer Number with Description: Method: get
Path: /service/accountfacility/vaenabledaccountswithDesc

Core Services/Multi-Currency Account Groups Service

This service is used to maintain multi-currency account group. It permits linking a real customer with its account and currency with a unique combination of account currency pair. In an account group, currency cannt be repeated.

Adds a new Multi-Currency Account Group: Method: post
Path: /service/multiccyaccountgroups
Close the Mutli Currency Account Groups by given Natural Composite Key: Method: patch
Path: /service/multiccyaccountgroups/{realCustomerNo}/{virtualMCA}/close
Get all valid Multi-Currency Account Groups: Method: get
Path: /service/multiccyaccountgroups
Modifies the Multi-Currency Account Groups by ID.: Method: put
Path: /service/multiccyaccountgroups/{realCustomerNo}/{virtualMCA}
Retrieves the Multi-Currency Account Groups by ID.: Method: get
Path: /service/multiccyaccountgroups/{realCustomerNo}/{virtualMCA}

ECA Services/Amount Block Service

This service allows to block amount on virtual accounts.

Adds a new ECA Block: Method: post
Path: /service/ecablock
Adds a new ECA Block with Skip DDA: Method: post
Path: /service/ecablockWithSkipDda
Deletes the ECA block identified by given block reference number: Method: delete
Path: /service/ecablock/{blockRefNo}
Get all ECA block: Method: get
Path: /service/ecablock
Release the ECA block by given block RefNo: Method: patch
Path: /service/ecablock/{blockRefNo}/release
Retrieves the ECA block by block reference number: Method: get
Path: /service/ecablock/{blockRefNo}

ECA Services/Exchange Rate Queue Service

This service allows to block amount on virtual accounts and it allows to input user rate from an exchange queue.

Authorize the amount Blocks by given ID: Method: post
Path: /service/amountBlockSerQueues

Entity Services/Bank Parameters Service

This services is used to maintain entity mask and bank code for bank in Oracle Banking Virtual Account Management, any UI application can be invoked to validate and persist the data.

Get all valid entity bank parameters: Method: get
Path: /service/entitybankparameters

Entity Services/Virtual Entity Service

This service is used to maintain virtual entity and is responsible for validating provided data and maintaining valid virtual entity account to the mask maintained for a bank parameter.

Adds new virtual entities: Method: post
Path: /service/virtualentities
Close the virtual entities by given virtual entity Id: Method: patch
Path: /service/virtualentities/{virtualEntityId}/close
Get all valid virtual entities: Method: get
Path: /service/virtualentities
Get the virtual entities by given virtual entity Id: Method: get
Path: /service/virtualentities/{virtualEntityId}
Retrives the id by given virtual entity Id: Method: get
Path: /service/virtualentities/idWithModNos/{virtualEntityId}
Retrives the virtual entities with Details of accounts under that entity for a given real customer.: Method: get
Path: /service/virtualentities/entitieswithaccountdetails
Update an existing virtual entities: Method: put
Path: /service/virtualentities/{virtualEntityId}

External Interest Engine Services/Interest Liquidation Service

This service is used to accure interest for a virtual account which can be liquidated.

Get all the transactions initiated for liquidating interest for virtual account: Method: get
Path: /service/interestLiq
Get Interest Liquidation for the given Source reference number: Method: get
Path: /service/interestLiq/{sourceReferenceNo}
Initiate interest liquidation for a virtual account: Method: post
Path: /service/interestLiq

Identifier Services/Identifier Map Service

This service is used to get list of identifier and its detail for a given customer.

Get all valid virtual identifier for a given customer: Method: get
Path: /service/idmaps/fetchIdentifier

Identifier Services/Remitter ID Service

This service is used to create remitter list ID. Remitter list ID is mapped to an identifier rule.

Get all valid remittance ids by customer number: Method: get
Path: /service/remitterids/getByCustomer
Update an existing remitter ids: Method: put
Path: /service/remitterids/{remitterListId}

Identifier Services/Remitter Service

This service helps in the creation of Remitter ID records for a Remitter List ID.

Adds a new remitter ids: Method: post
Path: /service/remitters
Close the remitter ids by given ID: Method: patch
Path: /service/remitters/{virtualIdentifier}/{remitterId}/close
Get all valid remitters: Method: get
Path: /service/remitters
Get count of valid remittance ids per identifier for a given customer: Method: get
Path: /service/remitterids/getremittercountforvi
Get count of valid remittanceids per identifier for a given customer: Method: get
Path: /service/remitters/downloadremitter/{realCustomerNo}/{virtualIdentifier}
Reopen the remitter ids by given ID: Method: patch
Path: /service/remitters/{virtualIdentifier}/{remitterId}/reopen
Update an existing remitter ids: Method: put
Path: /service/remitters/{virtualIdentifier}/{remitterId}

Inter Entity Position Service

This service is used for querying positions between entities at any given particular time.

Get all valid entity position enquiry: Method: get
Path: /service/entitypositionenquiry
Retrieves the entity positions by date range: Method: get
Path: /service/entitypositionenquiry/byDateRange

Internal Transfer Service

This services is used for internal transfer that enables balance transfer between two virtual account that belong to a real account.

Adds a new internal transfer: Method: post
Path: /service/intbks
Get all valid internal transfers: Method: get
Path: /service/intbks
Reverse the txn by given ID: Method: patch
Path: /service/intbks/{bookingRefNo}/reverse

Projection Services/Currency Wise Balance Service

This service is used to fetch currency wise balance for virtual account numbers for a real customer number.

Fetches currency wise balance for virtual account numbers for real customer number: Method: get
Path: /service/currencyWiseBalance

Projection Services/Distinct Currency Service

This service is used for distinct virtual account currency for a real customer.

Fetches distinct virtual account currency for a real customer: Method: get
Path: /service/distinctCurrencies
Fetches top five virtual accounts current balances based on a currency for a real customer number: Method: get
Path: /service/topFiveVirtualAccBalances

Projection Services/RM Customer360 View Service

This service is used for fetching Customer360 view for the real customer number.

Fetches Customer360 view for real customer number: Method: get
Path: /service/rmcustomer360view

Statement Services/Account Statement Service

This service is used to generate individual and consolidated account statement.

Fetch messages: Method: get
Path: /service/statement/fetch
Generate CAMT.052 statement: Method: post
Path: /service/statement/camt052
Generate CAMT.053 statement: Method: post
Path: /service/statement/camt053
Generate MT940 statement: Method: post
Path: /service/statement/mt940
Generate MT942 statement: Method: post
Path: /service/statement/mt942
Generate MT950 statement: Method: post
Path: /service/statement/mt950
Get all valid obvam-statement-services: Method: post
Path: /service/accStatement

Statement Services/Statement Preference Service

This Service is used for Statement Preferences defined for a virtual entity. Depending on statement type, frequency and due on values virtual account statements which contains a list of financial transactions will get generated.

Adds a new statement preference.: Method: post
Path: /service/statementprefs
Close a statement preference by Entity ID.: Method: patch
Path: /service/statementprefs/{entityId}/close
Update a statement preference by Entity ID: Method: put
Path: /service/statementprefs/{entityId}

Statement Services/Transaction Entries Service

This service is used by the transaction services for inserting data required for statement generation.

Download Transaction Enquiry: Method: post
Path: /service/txnEnquiryDownload
Get Transaction Enquiry: Method: get
Path: /service/obvamStatementServices

Transaction Journal Services/Journal Online Service

This service is used for Transaction Operations

Adds a new txn with skip DDA Enabled: Method: post
Path: /service/txnPostingWithSkipDda
Adds a new txn.: Method: post
Path: /service/txns
Retrieves the Real account for given Virtual Account/Virtual Identifier/Virtual Account IBAN: Method: get
Path: /service/realaccountforvirtual
Reverse/Rollback the txn by given txnRefNo: Method: patch
Path: /service/txns/{txnRefNo}/{action}
Updates the real customer number agains txn account: Method: put
Path: /service/realcustomermapping
URL for virtual account check from external systems: Method: post
Path: /service/eac

Transaction Journal Services/Transaction Exchange Queue Service

This service is used for Transaction exhange rate queue Operations.

Update a transaction exchange rate queue record: Method: post
Path: /service/txnqueues