Rest API for Oracle Banking Cash Management Cloud Service

All REST Endpoints

Account Maintenance Services/Accounting Service API

This service is used for Accounting's Operations

Add a new accounting entry code: Method: post
Path: /service/v1/accountingpost
Authorize the accounting entry code: Method: patch
Path: /service/v1/accountingpost/{refNo}/approve
Delete the accounting entry code by ID.: Method: delete
Path: /service/v1/accountingpost/{refNo}/purge
Fetch the 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/Pooling Accounting Service API

This service is used for Pooling Accounting Operations

Get account number: Method: post
Path: /service/v1/accountNumber
Process accounting entries and authorize for pooling tasks: Method: post
Path: /service/v1/poolingAccounting

Alerts services/Alert Category Service API's

Provides services for Alert category

Updates alert category: Method: post
Path: /obscfcm-alerts-services/service/v1/updateJobStatus

Cashflow Forecasting Services/Cashflow Inquiry API

This service helps to inquire Cashflow Transaction details

Fetches the list of cashflow transactions.: Method: get
Path: /service/v1/cashflow-maint/search

Cashflow Forecasting Services/Cashflow Transaction Service API

This service provides the channel request for creating Cashflow Transaction, Delete unauthorized Cashflow Transaction, KAFKA call back and fetching distinct cashflow transaction codes

Authorize cashflow transaction: Method: post
Path: /service/v1/authorizeCashflowTxn
Create a new cashflow transaction: Method: post
Path: /service/v1/cashflowInflowTxns
Delete the unauthorized cashflow transactions.: Method: post
Path: /service/v1/deleteUnAuthCashflowTxn
Fetch the distinct cashflow codes: Method: get
Path: /service/v1/cashflowCodes
Update cashflow transaction status after projection update: Method: post
Path: /service/v1/updateCashflowTxnStatus

Cashflow Projection Services/Cashflow Inquiry Service API

This service provides the APIs to inquire the Cashflow Transactions.

Fetches the list of cashflow transactions.: Method: get
Path: /obcm-cashflow-projection-services/service/v1/cashflow-maint/search

Cashflow Projection Services/Cashflow Report Service API

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

Retrieves Cashflow Transaction Data: Method: get
Path: /service/v1/nested/cashflowForecasting
Retrieves Predicted Cashflows Forecasting Data: Method: post
Path: /service/v1/receivePredictedResults
Retrieves the cashflow forecast report: Method: get
Path: /service/v1/cashflowForecasting
Retrieves the predicted cashflows data: Method: get
Path: /service/v1/cashflowSummary

Cashflow Report Service/Report Service API

This service provides the list of Dashboard API's used by the Channel.

Retrieves the cash deposit and cash withdrawal data: Method: get
Path: /service/v1/collectionChartData
Retrieves the instrument collection data: Method: get
Path: /service/v1/collectionChequeData

Charge Services/Charge Enquiry Service API

Tis service provides APIs to create, update, calculate and inquiry of charges.

Authorizes the charges transaction data: Method: get
Path: /service/v1/approveCharges
Calculate the charges for periodic charge transaction data: Method: get
Path: /service/v1/batchChargesTxnData
calculates and creates cash deposit charges transaction: Method: post
Path: /service/v1/cashDepositTxn
calculates and creates instrument collection charges transaction: Method: post
Path: /service/v1/chequeDepositTxn
calculates the charges: Method: post
Path: /service/v1/charges
create Cash Withdrawal Charges transaction: Method: post
Path: /service/v1/cashWithdrawalTxn
Create the charges transaction details: Method: post
Path: /service/v1/postChargesTxnData
Creates finance transaction details: Method: post
Path: /service/v1/postFinanceTxnData
Creates purchase order details: Method: post
Path: /service/v1/postPoTxnData
Creates the invoice transaction details: Method: post
Path: /service/v1/postInvoiceTxnData
fetch the authorized transaction details: Method: get
Path: /service/v1/getTxnDetails
Fetch the charges transaction data: Method: get
Path: /service/v1/chargesTxnData
Fetche charges details: Method: get
Path: /service/v1/chargeEnquiry
Update the charges transaction data for the given id: Method: patch
Path: /service/v1/chargesTxn/{id}

Charge Services/Charge Pricing Template Service API

This service describes the information about the Charge Pricing Template

Fetch pricing templates for given pricing category: Method: get
Path: /service/v1/prcMethods
Fetch the preferential pricing templates: Method: post
Path: /service/v1/getPrefChargeDetails
Fetch the pricing categories: Method: get
Path: /service/v1/prcCategory
Fetch the pricing templates: Method: post
Path: /service/v1/getChargeDetails

Collections Transaction Services/Arrangement Details and Pooling Date

This service provides the APIs for arrangement related details and pooling date

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

Collections Transaction Services/Batch Service

This service provides the APIs for Reject or Archieve the Cheque Instrument

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

Collections Transaction Services/Cash Deposit Service API

This service provides the APIs for Cash Deposit creation and inquiry and duplicate deposit slip number validation.

Creates cash deposit slip transaction: Method: put
Path: /service/v1/denominationCollection/update
Fetch cash deposit slip data: Method: get
Path: /service/v1/cashDepositInquiry
Validates cash depositSlip number: Method: get
Path: /service/v1/cashDeposit/duplicateValidation/{depositSlipNo}/{corporateId}

Collections Transaction Services/Cash Withdrawal API

This service provides the APIs for Cash Withdrawal creation and inquiry.

Authorizes cash withdrawal entry: Method: post
Path: /service/v1/authorizeWithdrawal
Creates cash withdrawal transaction: Method: put
Path: /service/v1/cashWithdrawalInquiry
Fetch the list of cash withdrawals: Method: get
Path: /service/v1/cashWithdrawalInquiry
Rejects cash withdrawal entry: Method: post
Path: /service/v1/rejectWithdrawal

Collections Transaction Services/Charge calculation API

This service provides the APIs for calculating charges for Cash Deposit and Cheque Deposit

Online charges for Cash Collection: Method: get
Path: /service/v1/collectionCharges
Online charges for Cheque Collection: Method: get
Path: /service/v1/collectionChequeCharges

Collections Transaction Services/Instrument Collection API

This service provides the APIs for Instrument collection creation, inquiry and duplicate deposit slip number/instrument number validation.

Creates Instrument collection transaction: Method: put
Path: /service/v1/instrumentCollection/update
Fetch the Instrument collection data: Method: get
Path: /service/v1/instrumentEnquiry
Fetch the list of instrument collection transaction: Method: get
Path: /service/v1/instrument
Validates Instrument Number and DepositSlip Number: Method: get
Path: /service/v1/instrumentCollection/duplicateCheck

Collections Transaction Services/Instrument Management Service API

This service provides the APIs for 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 provide APIs for external payment integration.

Send the instrument clearing status notification: Method: post
Path: /service/v1/clearingStatusNotification

Collections maintenance Services/Arrangement Decisioning Service API

This service provides the Inquiry APIs for Arrangement Decisioning maintenance

Fetch all the arrangement decisioning maintenance: Method: get
Path: /service/v1/decisioningmaster
Fetch the arrangement days: Method: post
Path: /service/v1/arrangementDecisioning/arrangementDays
Fetch the arrangement decisioning maintenance: Method: get
Path: /service/v1/decisioningmaster/{id}

Collections maintenance Services/Bank Branch Service API

This service provides the API information for bank branch operation.

Fetch the list of bank branch details: Method: get
Path: /service/v1/bankbranch
This API fetches core branch details: Method: post
Path: /service/v1/corebranch/getByLocList

Collections maintenance Services/Cash Denominations Service API

This Service provides the inquiry APIs for cash denomination maintenances

Fetch the list of denomination details: Method: get
Path: /service/v1/getCCYDenominationDetails
Fetch the list of distinct branch codes from denomination details: Method: get
Path: /service/v1/distinctBranchCode

Collections maintenance Services/Cash and Instrument Product API

Fetch all products of cash and instrument collections with description: Method: get
Path: /service/v1/product/productWithDesc
Fetch the product by product code and branch code: Method: get
Path: /service/v1/product/{productCode}/{branchCode}
Fetch the product by product type and network type: Method: get
Path: /service/v1/productSearch
Fetch the products of cash and instrument collections: Method: get
Path: /service/v1/product

Collections maintenance Services/Corporate Information Service API

This service provides the inquiry and update APIs for Corporate Enrichment

Fetch the corporate enrichment data: Method: get
Path: /service/v1/corporateinformation/enrichment
Fetch the corporate enrichment pooling details: Method: get
Path: /service/v1/corporateinformation/poolingsetup
Fetch the corporate enrichment products: Method: get
Path: /service/v1/corporateinformation/products
Update the pickup and delivery details for a corporate: Method: post
Path: /service/v1/corporateinformation/enrichment

Collections maintenance Services/Courier Setup Service API

This service provides the Inquiry API for courier setup maintenance.

Fetch the courier setup maintained: Method: get
Path: /service/v1/courier-setup

Collections maintenance Services/Location Cluster Service API

The service provides the Inquiry APIs for location cluster.

Fetch the list of location clusters: Method: get
Path: /service/v1/locationCluster
Fetch the location cluster by location clusterCode: Method: get
Path: /service/v1/locationCluster/{locationClusterCode}

Collections maintenance Services/Location Service API

This service provides the inquiry APIs for location code and maintenances.

Fetch the list of correspondant bank setup for location code: Method: get
Path: /service/v1/location/corrbanks/{locationCode}
Fetch the list of locations maintained: Method: get
Path: /service/v1/location
Fetch the list of outside network bank setup for location code: Method: get
Path: /service/v1/location/osnwbanks/{locationCode}
Fetch the location details by location code: Method: get
Path: /service/v1/locationmaster/{locationCode}
Fetch the location setup by location code: Method: get
Path: /service/v1/location/{locationCode}

Collections maintenance Services/Routing Service API

This service provides the inquiry API for Routing information.

Fetch list of routing data: Method: get
Path: /service/v1/routing

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 non-customer: 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 non-customer details: Method: put
Path: /service/v1/noncustomers
Modify the Counter Party: Method: put
Path: /service/v1/noncustomer
Onboard a new non-customer: Method: post
Path: /service/v1/noncustomers

Core Services/Non-Customer Service APIs v2

This service is used for non-customer Operations. User will be able to on-board new counter party with its attributes.

Create a new non-customer: Method: post
Path: /service/v0/noncustomer
Get all valid Non Customer: Method: get
Path: /service/v0/noncustomer
Update the non-customer data: Method: put
Path: /service/v0/noncustomer/{id}

Core Services/Payment Terms Service API

This service is used 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.

Maintain the specific payment frequencies and dates for buyers: 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. All parameter related to relationship will be configured through this service.

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

Core Services/Relationship Records Service API

This service is used to maintain the relationships between corporate and its buyers and sellers. All parameter related to relationship will be configured through this service.

Add a new relationshipmaster: Method: post
Path: /service/v1/relationshipRecords

Core Services/Relationship Service API

Service APIs to perform operations on Relationship

Fetch the existing relationships between associated parties: Method: get
Path: /service/v1/getRelationships

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.

Fetch the attribute name: Method: post
Path: /service/v1/filterNames
Filter the input: Method: post
Path: /service/v1/filterValues
Retrieves the 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 the 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 from external channels (V2): 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 (V2): Method: put
Path: /service/v2/updateCreditNote

Instruments Receivables Services/Discount Offer Service APIs

This service is used for Discount Offer Service layer Operations.

Create the discount offers: Method: post
Path: /service/v1/createDiscountOffer
Retrieves the list of Discount Offers: Method: post
Path: /service/v1/discountOffer
Retrieves the list of Discount Offers: Method: get
Path: /service/v1/discountOfferHistroryByInvoiceNo

Instruments Receivables Services/Instrument Finance Service APIs

This service is used for instruments finance service layer operations.

Initiates Finance: Method: post
Path: /service/v1/initiateFinance
Rollback finance transaction from po: Method: post
Path: /service/v1/poFinance/purgeTransaction
Updates status of invoice finance batches: Method: put
Path: /service/v1/instrumentUpdate

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 Auto Debit Service APIs

This service is used for Invoice Auto Debit Operations

AutoDebit from EOD: Method: get
Path: /service/v1/processAutoDebit
Create settlements for invoices with finances: Method: post
Path: /service/v1/createSettlementsForAutoDebit
Get auto debit transactions: Method: get
Path: /service/v1/getAutoDebitTxns/{executionId}
Process AutoDebit: Method: post
Path: /service/v1/approveAccounting
Process AutoDebit: Method: post
Path: /service/v1/cancelEcaForFailedInvoices
Process AutoDebit: Method: post
Path: /service/v1/createEca
Process AutoDebit: Method: post
Path: /service/v1/generateAccounting
Process AutoDebit: Method: post
Path: /service/v1/postToFcubs
Process AutoDebit: Method: post
Path: /service/v1/processAutoDebitTransactionDetails
Process AutoDebit: Method: post
Path: /service/v1/processLimits
Process AutoDebit: Method: post
Path: /service/v1/removeFailedAndAuthorizeSuccessfulInvoices
Process AutoDebit: Method: post
Path: /service/v1/updateAutoDebitMasterStatus
Process AutoDebit: Method: post
Path: /service/v1/updateProcessedAutoDebitInvoices

Instruments Receivables Services/Invoicing Service API

This service is used for Invoice Operations.

Acquire invoice task: Method: get
Path: /service/v1/acquireInvoiceTask
Add a main Invoices: Method: put
Path: /service/v1/authorizeInvoices
Add a new invoice in main table: Method: post
Path: /service/v1/invoice
Add a new invoice in stage table: Method: post
Path: /service/v1/stageInvoice
Authorise invoice from conductor: Method: post
Path: /service/v1/authorizeInvoice
Auto assign invoice: Method: post
Path: /service/v1/autoAssignInvoice
Enrich the invoice: Method: post
Path: /service/v1/enrichment
Evict business date cache: Method: get
Path: /service/v1/refreshBusinessDate
Generate the finance ref number: Method: get
Path: /service/v1/generateFinanceRefNo
Get edit invoice details: Method: post
Path: /service/v1/compareValuesOnEdit
Get invoices by transaction: Method: get
Path: /service/v1/getInvoiceMaintByTxnRefNo
Get margin inquiry data: Method: get
Path: /service/v1/marginInq
Instrument work update: Method: get
Path: /service/v1/instrumentWorkUpdate
Instruments payments status: Method: post
Path: /service/v1/isInstrumentPmtInProgress
Invoice approval marking: Method: get
Path: /service/v1/eod/limitsInvoiceApprovalMarking
Invoice files: Method: post
Path: /service/v1/autoInvoiceBatch
Invoice files: Method: post
Path: /service/v1/initiateInvoiceFinance
Invoice finance info: Method: get
Path: /service/v1/finances/{invoiceRefNo}
Invoice margin record: Method: post
Path: /service/v1/invoiceMarginCalc
Invoices for a finance transaction.: Method: post
Path: /service/v1/linkedInvFromFinance
List of finance reference numbers: Method: get
Path: /service/v1/getInvoiceFinanceRefNos
Margin reference number: Method: get
Path: /service/v1/generateMarginRefNo
Overdue invoices: Method: get
Path: /service/v1/overdueInvoice
Particular finance transaction.: Method: get
Path: /service/v1/invoices/{financeRefNo}
Payment incoming: Method: get
Path: /service/v1/paymentIncomingInvoiceValidation
Populate adhoc transaction: 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
Retrieve the list of existing invoices: Method: get
Path: /service/v1/getCurrentInvoceByInvRefNo
Retrieve the list of existing Invoices: Method: get
Path: /service/v1/invoice
Retrieve the list of existing invoices: Method: get
Path: /service/v1/invoiceSearch
Retrieve the list of existing tags: Method: get
Path: /service/v1/tags
Retrieve the list of historical status: Method: get
Path: /service/v1/historicalStatus
Retry prepost transaction: Method: post
Path: /service/v1/retryPrePostFinanceTransaction
Return discrepancy code: Method: get
Path: /service/v1/getDiscrepancyCode
Run invoice acceptance job: Method: get
Path: /service/v1/runInvoiceAcceptanceJob
Save invoice netting details: Method: post
Path: /service/v1/saveInvoiceNettingDetails
Stale invoices: Method: get
Path: /service/v1/staleInvoice
Update a invoice in main table.: Method: put
Path: /service/v1/invoice/{invoiceRefNo}
Update debit note: Method: put
Path: /service/v1/debitNote
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 invoices in main table: Method: put
Path: /service/v1/invoice
Update outstanding values: Method: post
Path: /service/v1/updateInvOutstandings
Updates invoice status: Method: post
Path: /service/v1/updateInvoiceForNetting
Used to approve instruments: Method: post
Path: /service/v1/invStageApprove
Used to reject instruments.: Method: post
Path: /service/v1/purgeTransaction
Used to retrieve the list of existing debit notes: Method: get
Path: /service/v1/debitNoteSearch

Instruments Receivables Services/Invoicing Service V2 API

This service is used for Invoicing Service V2 Operations.

Adds a new invoice in main table: Method: post
Path: /obscfcm-instruments-receivables-services/service/v2/invoice
Retrieves the invoice finance info for a particular finance transaction: Method: get
Path: /obscfcm-instruments-receivables-services/service/v2/invoiceFinance/{financeRefNo}
Retrieves the invoice finance info for a particular invoice: Method: get
Path: /obscfcm-instruments-receivables-services/service/v2/finances/{invoiceRefNo}
Retrieves the list of existing invoices: Method: get
Path: /obscfcm-instruments-receivables-services/service/v2/invoiceSearch
Status update for margin processing: Method: put
Path: /obscfcm-instruments-receivables-services/web/v1/invoiceMargin/statusUpdate
Updates the invoices in work table: Method: put
Path: /obscfcm-instruments-receivables-services/service/v2/invoice

Instruments Receivables Services/Invoicing Service V3 APIs

This service provides API for Invoice V3 Operations

Get linked invoices: Method: get
Path: /service/v3/linkedInvoiceFromPo
Retrieves the list of existing Invoices: Method: post
Path: /service/v3/invoiceSearch
Retrieves the status of existing invoices: Method: post
Path: /service/v3/fetchInvoicesStatus
Updates invoices: Method: put
Path: /service/v3/instrument

Instruments Receivables Services/Payment Service API

This service provides APIs to perform operations on payment transactions.

Authorizes the Payment transaction: Method: post
Path: /service/v1/authorizePayment
Creates authorized Payment transaction: Method: post
Path: /service/v1/nettingPaymentTm
Creates payment transaction in work table: Method: post
Path: /service/v1/nettingPaymentTw
Creates the payment transactions: Method: post
Path: /service/v1/payments
Excess Payment transaction details: Method: get
Path: /service/v1/excessPaymentInq
Fetch the Payment transaction details: Method: get
Path: /service/v1/paymentTwSearchByNumber
Fetch the payment transactions: Method: get
Path: /service/v1/getPaymentByPayRefNo
Fetches the payment transactions: Method: get
Path: /service/v1/getCurrentTwPayment
Fetches the payment transactions: Method: get
Path: /service/v1/getPaymentTwByPayRefNo
Fetches the payment transactions: Method: get
Path: /service/v1/paymentSearch
Fetches the payment transactions: Method: get
Path: /service/v1/paymentTwSearch
New payment in stage table: Method: post
Path: /service/v1/stagePayment
Payment data after invoice payment reconciliation: Method: patch
Path: /service/v1/invPayRecon
Payment for reconciliation transaction: Method: post
Path: /service/v1/checkForExcessPayment
Payment handling parameters: Method: get
Path: /service/v1/getExcessHandlingParameters
Posts payments from the stage to the main table: Method: post
Path: /service/v1/mainPayment
Purge payment transactions: Method: post
Path: /service/v1/purgePmtTransaction
Roll back Payment invoice: Method: post
Path: /service/v1/rollBackPaymentInvoiceTwTm
Rolls-back the amount and status for payment and credit note: Method: post
Path: /service/v1/purgeInstrumentsRecon
Update payment work: Method: get
Path: /service/v1/paymentUpdate
Update Payment Work: Method: get
Path: /service/v1/paymentWorkUpdate
Updates the payment status: Method: post
Path: /service/v1/allocationStatus

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 provides APIs to perform 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
Edit an existing authorised Purchase order: Method: post
Path: /service/v2/po/modify
Enrich the purchase order: Method: post
Path: /service/v1/po/enrichment
Existing purchase order: Method: get
Path: /service/v1/po
Get edit PO details: Method: post
Path: /service/v1/comparePOValuesOnEdit
Linked Purchase order by Invoice Ref No: Method: get
Path: /service/v1/linkedPoFromInvoice
Modify a existing authorised Purchase order: Method: post
Path: /service/v1/po/modify
Purchase order link program: Method: patch
Path: /service/v1/po/linkProgram
Purchase order link program: Method: patch
Path: /service/v2/po/linkProgram
Reject instruments: Method: post
Path: /service/v1/po/rejectPo
Retrieve and process the list of existing POs: Method: get
Path: /service/v1/processFutureDatedDisbursementPO
Retrieve the linked PO for a finance transaction: Method: post
Path: /service/v1/linkedPoFromFinance
Retrieve the list of PO finance: Method: get
Path: /service/v1/po/finances
Retrieve the list of POs: Method: get
Path: /service/v1/po/poInternalNumber
Retrieve the list of POs linked to the finance: Method: get
Path: /service/v1/po/linkedPOs/{financeRefNo}
Retrieve the list of purchase orders: Method: get
Path: /service/v1/getPoByTxnRef
Retrieve the purchase order finance info: Method: get
Path: /service/v1/poFinance/{financeRefNo}
Run purchase order acceptance job.: Method: get
Path: /service/v1/runPOAcceptanceJob

Instruments Receivables Services/Refund Service APIs

This service describes the information to perform refund Operations.

Authorizes steps from refund Process: Method: post
Path: /service/v1/authorizeRefund
Capturing success response of payment: Method: post
Path: /service/v1/updatePaymentResponse
Processes steps from purge refund: Method: post
Path: /service/v1/purgeRefundTransaction
Processes steps from refund Process: Method: post
Path: /service/v1/refundProcess
Runs payment refund Job: Method: get
Path: /service/v1/runRefundJob

InvoicingService

The operations from the InvoicingService category.

Retrieve the list of existing invoices: Method: get
Path: /service/v1/processFutureDatedDisbursement

Manual Reconciliation Services/Auto Reconciliation Service API

This service provides APIs for auto reconcilation.

Creates a new reconciliation rule: Method: post
Path: /service/v2/autoRecon
Get all reconciliation rule details: Method: get
Path: /service/v2/getReconRuleDetails
Get reconciliation rule definition details: Method: get
Path: /service/v2/getReconRuleValidateFlag

Manual Reconciliation Services/Auto Reconciliation Service V2 API

This service provides apis for fetching reconciliation rule details.

Creates a new reconciliation rule: Method: post
Path: /service/v1/autoRecon
Fetches 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 provides APIs for creation and inquiry of Reconciliation, Dereconciliation, Allocation and Deallocation transactions.

Check for pending transactions: Method: post
Path: /service/v1/checkForPendingTransactions
Create the new manual allocation transaction: Method: post
Path: /service/v1/initiateManualAlloc
Create the new reconciliation transaction: Method: post
Path: /service/v1/initiateManualRecon
Fetch the manual allocation transaction detail: Method: post
Path: /service/v1/getManualAlloc
Fetch the reconciliation transaction detail: Method: get
Path: /service/v1/getReconTmData
Fetch the reconciliation transaction details: Method: post
Path: /service/v1/getManualReconDetails
Initiate the new dereconciliation transaction: Method: post
Path: /service/v1/initiateManualDerecon
Retry exception queue manual recon transactions: Method: get
Path: /service/v1/retryReconTransactions
Validate reconciliation details: Method: post
Path: /service/v1/validateReconDiscountOffer

Manual Reconciliation Services/Reconciliation Rule Service API

This service provides APIs to fetch Reconciliation categories and post Allocation.

Fetch the reconciliation categories: Method: get
Path: /service/v1/reconAttributes
Fetch the reconciliation categories for a specific language: Method: get
Path: /service/v1/reconCategories
Initiate a new allocation transaction: Method: post
Path: /service/v1/postAllocation

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 Cash Management application parameters: Method: get
Path: /service/v1/cm/appParams
Retrieves reference number generation parameters: Method: get
Path: /service/v1/getRefNoGenParams
Retrieves Supply Chain Finance application parameters: Method: get
Path: /service/v1/appParams
Retrieves Supply Chain Finance master party parameters: Method: get
Path: /service/v1/parties
Retrieves Supply Chain Finance system parameters.: Method: get
Path: /service/v1/sysParams
Update an existing parameter: Method: patch
Path: /service/v1/sysParams/{key}

Netting Service/Netting Structure Service API

This service provides the APIs for Netting Structure Services Operations

Fetch the enrich details for the subsidiary: Method: get
Path: /service/v1/getAllChnlReqEnrichParamDtls
Retrieve all the netting structures: Method: get
Path: /service/v1/getStructureList
Retrieve the Netting Structure: Method: get
Path: /service/v1/getStructureTree
Retrieve the enrichment parameters: Method: get
Path: /service/v1/getStructureEnrichParams
Update the Netting Structure: Method: put
Path: /service/v1/updateStructureTree

Netting Service/Netting Transactions Service API

This Service is used for Netting Transactions Operations.

Approve/Reject the netting transaction: Method: post
Path: /service/v1/approveRejectNettingMgmtTxn
Create the netting transaction: Method: get
Path: /service/v1/runEligibilityJob
Fetch the list of netting inquiry transactions: Method: get
Path: /service/v1/getNettingInquiry
Generate and Post Accounting Entries: Method: post
Path: /service/v1/nettingPayOutTask
Initiate pay in out for a transaction.: Method: put
Path: /service/v1/updatePayInOut
Recalculation of payin-payout: Method: get
Path: /service/v1/nettingSettlement
Retrieve the list of Netting Transactions: Method: get
Path: /service/v1/getNettingInvoiceInquiryDetails
Retrieve the list of pay out transactions: Method: get
Path: /service/v1/payInOutListing
Retrieves the list of associated receivables and payables: Method: get
Path: /service/v1/netInvDetForNettMgmt
Retrieves the list of subsidiaries linked to the netting transaction: Method: get
Path: /service/v1/getAllSubsidiaries
Retrieves the list of transactions for netting management: Method: get
Path: /service/v1/getTxnsForNettingMgmt
Retrieves the netting management basic information and Fx details: Method: get
Path: /service/v1/netTxnsDetForNettMgmt
Update the netting transaction Status as accepted: Method: get
Path: /service/v1/nettingAcceptanceTxn
Updates the latest Fx rates and amounts for netting transactions: Method: get
Path: /service/v1/updateFxRates
Updating the netting transaction received from Channel: Method: put
Path: /service/v1/netTxnsDetForNettMgmt

Workflow Managenent Services/Conductor Service

This service is used for interface between conductor and service.

Get fact data: Method: post
Path: /service/v1/fetchFactData
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