Rest API for Oracle Banking Cash Management

All REST Endpoints

Account Maintenance Services/Accounting Service API

This service is used for Accounting's Operations

Adds a new accounting entry code: Method: post
Path: /service/v1/accountingpost
Authorize the accounting entry code by given ID: Method: patch
Path: /service/v1/accountingpost/{refNo}/approve
Delete the accounting entry code by ID: Method: delete
Path: /service/v1/accountingpost/{refNo}/purge
Fetch Accounting Transaction Details: Method: post
Path: /service/v1/fetchAccountingTxnDetails
Get all account details: Method: get
Path: /service/v1/accountDetails
Get all accounting details: Method: post
Path: /service/v1/accountinggeneric
Get all accounting entries: Method: post
Path: /service/v1/accounting
Get all accounting numbers: Method: post
Path: /service/v1/poolingAccountNumber
Get all valid accounting entry code: Method: get
Path: /service/v1/accountingpost
Get Party based on the account number: Method: get
Path: /service/v1/internalAccount/party
Get Party Id: Method: get
Path: /service/v1/partyId
Update external system response status: Method: post
Path: /service/v1/updateExternalSystemResponse

Account Maintenance Services/FCUBS Accounting Service API

This service is used for FCUBS related Operations

Cancel ECA Block: Method: get
Path: /service/v1/cancelEca
Create ECA Block: Method: get
Path: /service/v1/createEca
Post Accounting Entries to FCUBS: Method: get
Path: /service/v1/postAcc

Account Maintenance Services/Pooling Accounting Service API

This service is used for Pooling Accounting Operations

Account Number: Method: post
Path: /service/v1/accountNumber
Process accounting entries and authorize for pooling tasks: Method: post
Path: /service/v1/poolingAccounting

Account Maintenance Services/VAM Service API

This service is used for VAM Operations.

Post virtual accounts: Method: get
Path: /service/v1/postVirtualAcc

Cashflow Forecasting Services/Cashflow Transaction Service API

This service provides for channel request for cashflow transaction, Delete unauthorised transaction, KAFKA call back and fetching distinct cashflow transaction codes.

Adds a new cashflow Tm transaction: Method: post
Path: /service/v1/cashflowInflowTxns
Authorizes cashflow transaction: Method: post
Path: /service/v1/authorizeCashflowTxn
Deleting unAuthorize cashflow transactions: Method: post
Path: /service/v1/deleteUnAuthCashflowTxn
Retrieves cashflow Codes: Method: get
Path: /service/v1/cashflowCodes
Update Process status cashflow transaction: Method: post
Path: /service/v1/updateCashflowTxnStatus

Cashflow Projection Services/Cashflow Daily Summary Service API

This Service is called when transaction flows through KAFKA, to build daily summary

API to get data for ML reference number: Method: get
Path: /service/v1/dataForMlRefNumber/{mlReferenceNo}
API to update Daily Cashflow Summary: Method: post
Path: /service/v1/summarizeDailyCashflows

Cashflow Projection Services/Cashflow Report Service API

This service provides aggregate levels of cashflow forecasting for daily, monthly , quarterly, Weekly and retrieves the actual and predicted Cashflows based on given set of parameters.

Retrieves Cashflow Forecasting report: Method: get
Path: /service/v1/cashflowForecasting
Retrieves Cashflow ML Transaction: Method: get
Path: /service/v1/cashflowSummary
Retrieves Nested Cashflow Forecasting report: Method: get
Path: /service/v1/nested/cashflowForecasting
Retrieves Predicted Cashflows Result: Method: post
Path: /service/v1/receivePredictedResults

Cashflow Projection Services/Cashflow Search Service API

This service helps to perform Cashflow Search function.

Retrieves Cashflows: Method: get
Path: /service/v1/cashflow-maint/search

Cashflow Report Service/Report Service API

This Service is used for Report related Operations

Retrieves the chart data for cash deposit and cash withdrawal: Method: get
Path: /service/v1/collectionChartData
Retrieves the chart data for cheque: Method: get
Path: /service/v1/collectionChequeData

Charge Services/Charge Enquiry Service API

This service is used to facilitates the maintenance of charge enquiries.

Approve charges transaction data: Method: get
Path: /service/v1/approveCharges
Charges Enquiry: Method: get
Path: /service/v1/chargeEnquiry
Creates cash deposit transaction details record: Method: post
Path: /service/v1/cashDepositTxn
Creates charges transaction details record: Method: post
Path: /service/v1/postChargesTxnData
Creates cheque deposit transaction details record: Method: post
Path: /service/v1/chequeDepositTxn
Creates finance transaction details record: Method: post
Path: /service/v1/postFinanceTxnData
Creates invoice transaction details record: Method: post
Path: /service/v1/postInvoiceTxnData
Creates purchase order details record: Method: post
Path: /service/v1/postPoTxnData
Performs Charge Calculation: Method: post
Path: /service/v1/charges
Processes charge transaction data & calculates charges for periodic charge transaction data: Method: get
Path: /service/v1/batchChargesTxnData
Provides transaction details: Method: get
Path: /service/v1/getTxnDetails
Retrieves charges transaction data: Method: get
Path: /service/v1/chargesTxnData
Updates the charges transaction data for given id: Method: patch
Path: /service/v1/chargesTxn/{id}

Charge Services/Charge Pricing Template Service API

This service is used for charge Pricing Template Service

Gives all pricing categories: Method: get
Path: /service/v1/prcCategory
Gives best possible combination for the given category: Method: post
Path: /service/v1/getChargeDetails
Gives best possible combination for the given category: Method: post
Path: /service/v1/getPrefChargeDetails
Gives best possible combination for the given category: Method: get
Path: /service/v1/prcMethods

Collections Transaction Services/Arrangement Details and Pooling Date API

This service is used for arrangement related details and pooling date operations.

Identify Arrangement and Pooling Date: Method: post
Path: /service/v1/identifyArrDet

Collections Transaction Services/Cash Deposit Charges API

This service is used for Cash Deposit and Cheque Deposit related charges.

Calculate the online charges for Cash Collection: Method: get
Path: /service/v1/collectionCharges
Calculate the online charges for Cheque Collection: Method: get
Path: /service/v1/collectionChequeCharges

Collections Transaction Services/Cash Deposit Service API

This service is used for related to Cash Deposit Inquiry and duplicate check and Put request from Channel.

Retrieves the deposit slip: Method: get
Path: /service/v1/cashDepositInquiry
Retrieves validation details: Method: get
Path: /service/v1/cashDeposit/duplicateValidation/{depositSlipNo}/{corporateId}
Update an existing denomination collection: Method: put
Path: /service/v1/denominationCollection/update

Collections Transaction Services/Cash Withdrawal API

This service is used for Cash Witdrawal Inquiry, PUT request from external channel, Reject and Authorise

Authorizes new withdrawal entry from conductor: Method: post
Path: /service/v1/authorizeWithdrawal
rejects new withdrawal entry from conductor: Method: post
Path: /service/v1/rejectWithdrawal
Retrieves the list of existing cash withdrawal: Method: get
Path: /service/v1/cashWithdrawalInquiry
To Create the cash withdrawal from an external application like OBDX and sent the request to oracle banking cash management: Method: put
Path: /service/v1/cashWithdrawalInquiry

Collections Transaction Services/Instrument Collection API

This Service is used for PUT request from channel,Inquiry and Duplicate check validation for Instrument Collection

Duplicate Checking for Instrument Collection: Method: get
Path: /service/v1/instrumentCollection/duplicateCheck
Retrieves the Instrument based on the given parameters: Method: get
Path: /service/v1/instrumentEnquiry
Retrieves the list of existing Instrument: Method: get
Path: /service/v1/instrument
Update an existing instrument collection: Method: put
Path: /service/v1/instrumentCollection/update

Collections Transaction Services/Instrument Collection Purge Service API

This Service is used to either Reject or Archive the Cheque/ Instrument's

Purge Batch transaction: Method: post
Path: /service/v1/instrumentCollection/purge
Reject Batch transaction for Rework: Method: post
Path: /service/v1/instrumentCollection/reject

Collections Transaction Services/Instrument Management Service API

This service is used to Purge and Reject of Instrument management related functions.

Purge instrument management transaction: Method: post
Path: /service/v1/instrumentManagement/purge
Reject instrument management transaction: Method: post
Path: /service/v1/instrumentManagement/reject

Collections Transaction Services/Payment Integration API

This service is used for notification api and models required for obcm obpm integration.

Notification api consumed by OBPM to send the instrument clearing status: Method: post
Path: /service/v1/OBCMClgStatusNS

Collections maintenance Services/Arrangement Decisioning Service API

This service is Inquiry for Arrangement Decisioning master

Get all valid decisioning master: Method: get
Path: /service/v1/decisioningmaster
Retrieves the Arrangement days by given parameters: Method: post
Path: /service/v1/arrangementDecisioning/arrangementDays
Retrieves the decisioning master by ID: Method: get
Path: /service/v1/decisioningmaster/{id}

Collections maintenance Services/Bank Branch Service API

This service is used for Bank Branch Operations.

Inserts Bank Branch Entries: Method: post
Path: /service/v1/corebranch/getByLocList
Retrieves the list of bank branch entries: Method: get
Path: /service/v1/bankbranch

Collections maintenance Services/Cash Denominations Service API

This service is used for Cash Denomination

Retrieves the list of CCY and Debomination Details: Method: get
Path: /service/v1/getCCYDenominationDetails
Retrieves the list of Distinct Branch Codes: Method: get
Path: /service/v1/distinctBranchCode

Collections maintenance Services/Cash and Instrument Product API

The service is used to provide the lists of products available for Cash Deposit and Instrument Deposit.

Get all valid product: Method: get
Path: /service/v1/product
Get all valid product: Method: get
Path: /service/v1/product/productWithDesc
Retrieves the product by Product and Network type: Method: get
Path: /service/v1/productSearch
Retrieves the product by Product Code and Branch Code: Method: get
Path: /service/v1/product/{productCode}/{branchCode}

Collections maintenance Services/Corporate Information Service API

This service is used to provide information about products of corporate

Get all valid corporate information service enrichment data: Method: get
Path: /service/v1/corporateinformation/enrichment
Get all valid corporate information service pooling setups: Method: get
Path: /service/v1/corporateinformation/poolingsetup
Get all valid corporate information service products: Method: get
Path: /service/v1/corporateinformation/products
Update an existing Corporate Enrichment Data Segments for Pickup and Delivery: Method: post
Path: /service/v1/corporateinformation/enrichment

Collections maintenance Services/Courier Setup Service API

This service is Inquiry API for the list of Courier Maintained

Get all valid courier setup: Method: get
Path: /service/v1/courier-setup

Collections maintenance Services/Location Cluster Service API

This service is used to provide the list of Inquiry APIs for Location cluster

Get all valid location clusters: Method: get
Path: /service/v1/locationCluster
Retrieves the location cluster by location cluster code: Method: get
Path: /service/v1/locationCluster/{locationClusterCode}

Collections maintenance Services/Location Service API

This service is used to get the list of Inquiry APIs for Location master.

Get all valid location: Method: get
Path: /service/v1/location
Retrieves the location by location code: Method: get
Path: /service/v1/location/corrbanks/{locationCode}
Retrieves the location by location code: Method: get
Path: /service/v1/location/osnwbanks/{locationCode}
Retrieves the location by location code: Method: get
Path: /service/v1/location/{locationCode}
Retrieves the location by location code: Method: get
Path: /service/v1/locationmaster/{locationCode}

Collections maintenance Services/Routing Service API

This service is used to GET API for Routing information.

Retrieves the list of Routing data: Method: get
Path: /service/v1/routing

Common Core Services/Account Service API

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/Branch Service API

This service is used for local holidays operations.

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

Common Core Services/Currency Service API

This service 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
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 currencyratetypes 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 rule: Method: put
Path: /service/currencydefinitions/{currencyCode}/{maintenanceCountry}
Update an existing rule: Method: put
Path: /service/currencyholidaycalendars/{currency}/{year}
Update an existing rule: Method: put
Path: /service/currencypairs/{currency1}/{currency2}/{maintenanceCountry}
Update an existing rule: Method: put
Path: /service/currencyratetypes/{currencyRateType}
Update an existing rule: Method: put
Path: /service/rates

Common Core Services/Customer Service API

This is the service 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 core customers: Method: post
Path: /service/corecustomers
Close the corecustomers 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 corecustomers by providing array of customer numbers: Method: get
Path: /service/corecustomers
Update an existing core customers: Method: put
Path: /service/corecustomers/{customerNo}

Core Services/Customer Delinquency Service API

This service is used for Customer Delinquency Status Operations.

Adds a new delinquency status: Method: post
Path: /service/v1/delinquencyStatus/customerStatus
Adds a new delinquency status: Method: post
Path: /service/v1/delinquencyStatus/customerStatusMaster
Adds a new delinquency status: Method: post
Path: /service/v1/delinquencyStatus/externalCustomerDelinqStatus
Get all valid customer delinquency status: Method: get
Path: /service/v1/delinquencyStatus/allCustomerStatus
Get all valid customer delinquency status: Method: get
Path: /service/v1/delinquencyStatus/customerStatus
Get all valid customer external delinquency status: Method: get
Path: /service/v1/delinquencyStatus/customerStatusMaster

Core Services/Division Code Service API

This service is used for Customer Division Code Operations.

Adds a new division code: Method: post
Path: /service/v1/divisioncode/division
Deletes/Closes a new division code: Method: patch
Path: /service/v1/divisioncode/division
Get all valid division code: Method: get
Path: /service/v1/divisioncode/division

Core Services/Non-Customer Service API

This service is for non-customer operations.

Authorize the noncustomer by given rel_ref_id: Method: put
Path: /service/v1/noncustomers/{relRefId}/approve
Generate Non Customer ID: Method: get
Path: /service/v1/generateNonCustId
Get all valid Non Customer: Method: get
Path: /service/v1/noncustomer
Get all valid Non Customer code: Method: get
Path: /service/v1/getNonCustomerCode
Modify counter party if exist: Method: put
Path: /service/v1/noncustomer
On boards Counter Party: Method: post
Path: /service/v1/noncustomers
On boards Counter Party: Method: put
Path: /service/v1/noncustomers

Core Services/Payment Terms Service API

This service is for payment terms that will allow the bank to maintain specific payment frequencies and dates for buyers making bulk payments on repetitive fixed dates. Thus, payment frequencies such as weekly, monthly etc. can be maintained against each buyer. The screen is extensible and allows for maintenance against specific suppliers of a buyer. Maintenance of multiple payment dates against the same invoice is out of scope.

Filters the payment terms by given input parameters: Method: post
Path: /service/v1/filter

Core Services/Relationship Master Service API

This service is used for maintaining relationships between corporate and its buyers and sellers.

Adds a new relationship master: Method: post
Path: /service/v1/relationshipmaster/noncustomer
Check expiry of each relationship at the end of the day: Method: get
Path: /service/v1/checkRelationshipExpiry
Fetch CounterParty Details for given External Code: Method: get
Path: /service/v1/relationshipmaster/nonCustomerDetails/{externalCode}
Fetch external code for given associated party: Method: get
Path: /service/v1/relationshipmaster/externalCode
Fetch relationship master for given associated party: Method: get
Path: /service/v1/relationshipmaster/associatedPartiesList
Fetch relationship master for given relationship code: Method: get
Path: /service/v1/relationshipmaster/associatedParty
Get all valid relationship master: Method: get
Path: /service/v1/buyerseller/relationshipmaster

Core Services/Supplier Commodity Service API

This service is for commodity operations.

Adds a new supplier commodity code: Method: post
Path: /service/v1/scommodity
Get all valid supplier commodity code: Method: get
Path: /service/v1/scommodity

Filter Services/Filter Service API

This Service is used for Filter Operations.

Filter Input: Method: post
Path: /service/v1/filterValues
Gives the attribute name for given attribute value: Method: post
Path: /service/v1/filterNames
Retrieves Filter Criteria Query: Method: get
Path: /service/v1/filterQuery

Instruments Receivables Services/Credit Note Service API

This service is used for Credit Note Service layer Operations.

Authorize Credit Note: Method: post
Path: /service/v1/authorizeCreditNote
Create new credit note from external channels: Method: post
Path: /service/v1/createCreditNote
Create new credit note V2 from external channels: Method: post
Path: /service/v2/createCreditNote
Deletes corresponding data upon Transaction Purge: Method: post
Path: /service/v1/purgeCrnTransaction
Retrieves current unauthorised credit note: Method: get
Path: /service/v1/getUnauthTwCreditNoteRecord
Retrieves the list of existing credit notes: Method: get
Path: /service/v1/creditNoteSearch
Updates the list of existing credit notes: Method: put
Path: /service/v1/updateCreditNote
Updates the list of existing credit notes: Method: put
Path: /service/v2/updateCreditNote

Instruments Receivables Services/Invoice Charges Service API

This service is used for Invoice Charge Operations

Calculate the online charges for invoices: Method: get
Path: /service/v1/invoiceCharges

Instruments Receivables Services/Invoice Process Service API

This service is used for Invoice Operations.

Performs invoice actions based on workflow task: Method: post
Path: /service/v1/invoiceprocess

Instruments Receivables Services/Invoicing Service API

This service is used for Invoice Operations.

Acquire invoice task: Method: get
Path: /service/v1/acquireInvoiceTask
Adds a main Invoices after validation: Method: put
Path: /service/v1/authorizeInvoices
Adds a new Invoice in main table.: Method: post
Path: /service/v1/invoice
Adds a new invoice in stage table.: Method: post
Path: /service/v1/stageInvoice
Approve instruments in workflow: Method: post
Path: /service/v1/invStageApprove
Authorise invoice from conductor: Method: post
Path: /service/v1/authorizeInvoice
Batches the selected invoice files: Method: post
Path: /service/v1/autoInvoiceBatch
Batches the selected Invoice files: Method: post
Path: /service/v1/initiateInvoiceFinance
Creates a new invoice margin record: Method: post
Path: /service/v1/invoiceMarginCalc
Enrich the invoice with necessary fields for creation: Method: post
Path: /service/v1/enrichment
Find overdue invoices: Method: get
Path: /service/v1/overdueInvoice
Find stale invoices: Method: get
Path: /service/v1/staleInvoice
Generates the finance reference number: Method: get
Path: /service/v1/generateFinanceRefNo
Generates the margin reference number for a particular invoice: Method: get
Path: /service/v1/generateMarginRefNo
Get file status By file name: Method: get
Path: /service/v1/getFileStatusByFileName
Get Invoices by Transaction Ref No from TM: Method: get
Path: /service/v1/getInvoiceMaintByTxnRefNo
Invoice Approval Marking: Method: get
Path: /service/v1/eod/limitsInvoiceApprovalMarking
Payment Incoming 2nd stage Invoice Validation: Method: get
Path: /service/v1/paymentIncomingInvoiceValidation
Populate adhoc transaction details: Method: post
Path: /service/v1/setAdhocTxnDetails
Process margin handling: Method: post
Path: /service/v1/processMarginHandling
Process margin refund: Method: post
Path: /service/v1/createMarginRefundPmt
Process margin refund: Method: post
Path: /service/v1/marginRefundPmt
Process margin refund: Method: post
Path: /service/v1/postMarginAccEntries
Process margin refund: Method: post
Path: /service/v1/processMarginRefund
Reject instruments: Method: post
Path: /service/v1/purgeTransaction
Retrieves the Invoice Finance Info for a particular Invoice: Method: get
Path: /service/v1/finances/{invoiceRefNo}
Retrieves the Invoices for a particular Finance Transaction: Method: get
Path: /service/v1/invoices/{financeRefNo}
Retrieves the list of existing debit notes: Method: get
Path: /service/v1/debitNoteSearch
Retrieves the list of existing Invoices: Method: get
Path: /service/v1/getCurrentInvoceByInvRefNo
Retrieves the list of existing Invoices: Method: get
Path: /service/v1/invoice
Retrieves the list of existing invoices: Method: get
Path: /service/v1/invoiceSearch
Retrieves the list of existing invoices: Method: get
Path: /service/v1/processFutureDatedDisbursement
Retrieves the list of existing Tags: Method: get
Path: /service/v1/tags
Retrieves the list of Finance reference number for given RequestId: Method: get
Path: /service/v1/getInvoiceFinanceRefNos
Returns Discrepancy Code: Method: get
Path: /service/v1/getDiscrepancyCode
Runs invoice acceptance job: Method: get
Path: /service/v1/runInvoiceAcceptanceJob
Update existing Invoices: Method: patch
Path: /service/v1/linkPrograms
Update existing invoices: Method: patch
Path: /service/v1/mainInvoice
Update invoice in settlement: Method: put
Path: /service/v1/genericUpdate
Update invoice in settlement: Method: put
Path: /service/v1/settlementStatusUpd
Update outstanding values in invoice: Method: post
Path: /service/v1/updateInvOutstandings
Updates a Invoice in main table: Method: put
Path: /service/v1/invoice/{invoiceRefNo}
Updates Debit Note in Tw table: Method: put
Path: /service/v1/debitNote
Updates Invoices in main table: Method: put
Path: /service/v1/invoice

Instruments Receivables Services/Payment Service API

This service is used for Payment Operations

Adds all the main payments from the stage to the main table after validation: Method: post
Path: /service/v1/mainPayment
Authorize a Payment.: Method: post
Path: /service/v1/authorizePayment
Check for excess payment for a reconciliation transaction reference number: Method: post
Path: /service/v1/checkForExcessPayment
Create new bulk Payment: Method: post
Path: /service/v1/payments
Create new Payment in stage table: Method: post
Path: /service/v1/stagePayment
Create payment Tm for netting: Method: post
Path: /service/v1/nettingPaymentTm
Create payment Tw for netting: Method: post
Path: /service/v1/nettingPaymentTw
Get Payments by Payment Reference Number from TM: Method: get
Path: /service/v1/getPaymentByPayRefNo
Get Payments by Payment Reference Number from TW: Method: get
Path: /service/v1/getPaymentTwByPayRefNo
Gets Payments: Method: get
Path: /service/v1/paymentSearch
Gets Payments: Method: get
Path: /service/v1/paymentTwSearch
Gets Payments by Payment Number: Method: get
Path: /service/v1/paymentTwSearchByNumber
Purge instruments reconciliation: Method: post
Path: /service/v1/purgeInstrumentsRecon
Purge payment transactions: Method: post
Path: /service/v1/purgePmtTransaction
Retrieves excess handling parameters: Method: get
Path: /service/v1/getExcessHandlingParameters
Retrieves the list of existing Invoices: Method: get
Path: /service/v1/getCurrentTwPayment
Roll back Payment Invoice Tw Tm For Netting Failure: Method: post
Path: /service/v1/rollBackPaymentInvoiceTwTm
Update allocation status: Method: post
Path: /service/v1/allocationStatus
Update API for Invoice Payment Reconciliation: Method: patch
Path: /service/v1/invPayRecon

Instruments Receivables Services/Purchase Order Charges Service API

This service is used for Purchase Order Charge Operations.

Calculate the online charges for Purchase Orders: Method: get
Path: /service/v1/poCharges

Instruments Receivables Services/Purchase Order Service API

This service is for Purchse Order Operations.

Adds a new Purchase Order: Method: post
Path: /service/v1/po/create
Authorise purchase order from conductor: Method: post
Path: /service/v1/po/authorizePo
Enrich the purchase oder with necessary fields for creation: Method: post
Path: /service/v1/po/enrichment
Modify a existing authorised Purchase Order: Method: post
Path: /service/v1/po/modify
Purchase Order Link Program: Method: patch
Path: /service/v1/po/linkProgram
Reject instruments: Method: post
Path: /service/v1/po/rejectPo
Retrieves the List of purchase order linked to the finance: Method: get
Path: /service/v1/po/linkedPOs/{financeRefNo}
Retrieves the purchase order finance info for a particular purchase order: Method: get
Path: /service/v1/poFinance/{financeRefNo}
Runs purchase order acceptance job: Method: get
Path: /service/v1/runPOAcceptanceJob
Search for an existing purchase order: Method: get
Path: /service/v1/po

Manual Reconciliation Services/Auto Reconciliation Service API

This service is for auto reconcilation.

Adds a new auto reconciliation: Method: post
Path: /service/v1/autoRecon
Get all reconciliation rule details: Method: get
Path: /service/v1/getReconRuleDetails
Get all rule set: Method: get
Path: /service/v1/reconExecRules
Get all the valid rule set: Method: post
Path: /service/v1/reconExecRulesDetails

Manual Reconciliation Services/Manual Reconciliation Service API

This service is for Reconciliation, Dereconciliation, Allocation & Deallocation.

Creates new dereconciliation transaction: Method: post
Path: /service/v1/initiateManualDerecon
Creates new manual allocation transaction: Method: post
Path: /service/v1/initiateManualAlloc
Creates the new reconcilation transaction: Method: post
Path: /service/v1/initiateManualRecon
Evicts business date cache: Method: get
Path: /service/v1/refreshBusinessDate
Gets manual allocation transaction detail: Method: post
Path: /service/v1/getManualAlloc
Gets reconcilation transaction detail: Method: post
Path: /service/v1/getManualReconDetails
Gets reconcilation transaction detail: Method: get
Path: /service/v1/getReconTmData

Manual Reconciliation Services/Reconciliation Rule Service API

This service is for reconcilation rule Service api, user gets attributes on which reconcilation and allocation happens

Posts a new allocation transaction to VAM: Method: post
Path: /service/v1/postAllocation
Posts a new auto allocation transaction to VAM: Method: get
Path: /service/v1/postAutoAllocation
Provides all reconcilation attributes for a specific language: Method: get
Path: /service/v1/reconAttributes
Provides all reconcilation categories for a specific language: Method: get
Path: /service/v1/reconCategories

Manual Reconciliation Services/VAM Reconciliation Service API

This service is used to call in VAM services

Fetches virtual accounts as per the attributes: Method: post
Path: /service/v1/fetchVirtualAccounts

Master Maintenance Services/Master Maintenance Service API

This service provides APIs for maintaining system, application, and other parameters.

Get all valid external system product code: Method: get
Path: /service/v1/product/externalProduct
Get the valid delinquency status: Method: get
Path: /service/v1/product/delinquencyStatus
Retrieves OBCM Application Parameters: Method: get
Path: /service/v1/cm/appParams
Retrieves Reference Number Generation Parameters: Method: get
Path: /service/v1/getRefNoGenParams
Retrieves scf Application Parameters: Method: get
Path: /service/v1/appParams
Retrieves SCF Master Party Parameters: Method: get
Path: /service/v1/parties
Retrieves SCF System Parameters: Method: get
Path: /service/v1/sysParams
Update an existing parameter: Method: patch
Path: /service/v1/sysParams/{key}

Netting Services/Netting Transacation Service API

This service is used for Netting Transaction Operations.

Change status to settled and update is netting flag: Method: post
Path: /service/v1/settlementStatusUpdate
Change status to settled and update is netting flag.: Method: post
Path: /service/v1/updateNettingTxn
Retrieves the List Of Invoices for Netting Transactions: Method: get
Path: /service/v1/getNettingTxnInvoices
Retrieves the list of Netting Transactions: Method: get
Path: /service/v1/getNettingTxn
Retrieves the list of Netting Transactions for acceptance Job: Method: get
Path: /service/v1/nettingAcceptanceTxn
Update Netting Transactions Status: Method: put
Path: /service/v1/nettingTxnStatus

Security Management System Services/User Service

This service is used for creating the User related operations.

Adds a new user: Method: post
Path: /service/user
Update an existing user: Method: put
Path: /service/user/{userLoginId}

Workflow Managenent Services/Conductor Service

This service is used for interface between conductor and service.

Initiates the workflow from the conductor: Method: post
Path: /service/v1/initiateWorkflow
Interface to handle HTTP Task from Conductor: Method: post
Path: /service/v1/handleHTTPTask
Updates the manual task from the conductor: Method: post
Path: /service/v1/updateManualTask