All REST Endpoints
Account Maintenance Services/Accounting Service API
This service is used for Accounting's Operations
- Adds a new accounting entry code
- Method: postPath:
/service/v1/accountingpost
- Authorize the accounting entry code by given ID
- Method: patchPath:
/service/v1/accountingpost/{refNo}/approve
- Delete the accounting entry code by ID
- Method: deletePath:
/service/v1/accountingpost/{refNo}/purge
- Fetch Accounting Transaction Details
- Method: postPath:
/service/v1/fetchAccountingTxnDetails
- Get all account details
- Method: getPath:
/service/v1/accountDetails
- Get all accounting details
- Method: postPath:
/service/v1/accountinggeneric
- Get all accounting entries
- Method: postPath:
/service/v1/accounting
- Get all accounting numbers
- Method: postPath:
/service/v1/poolingAccountNumber
- Get all valid accounting entry code
- Method: getPath:
/service/v1/accountingpost
- Get Party based on the account number
- Method: getPath:
/service/v1/internalAccount/party
- Get Party Id
- Method: getPath:
/service/v1/partyId
- Update external system response status
- Method: postPath:
/service/v1/updateExternalSystemResponse
Account Maintenance Services/FCUBS Accounting Service API
This service is used for FCUBS related Operations
- Cancel ECA Block
- Method: getPath:
/service/v1/cancelEca
- Create ECA Block
- Method: getPath:
/service/v1/createEca
- Post Accounting Entries to FCUBS
- Method: getPath:
/service/v1/postAcc
Account Maintenance Services/Pooling Accounting Service API
This service is used for Pooling Accounting Operations
- Account Number
- Method: postPath:
/service/v1/accountNumber
- Process accounting entries and authorize for pooling tasks
- Method: postPath:
/service/v1/poolingAccounting
Account Maintenance Services/VAM Service API
This service is used for VAM Operations.
- Post virtual accounts
- Method: getPath:
/service/v1/postVirtualAcc
Cashflow Forecasting Services/Cashflow Inquiry API
This service helps to inquire Cashflow Transaction details.
- Fetches the list of cashflows
- Method: getPath:
/obcm-cashflow-forecasting-services/service/v1/cashflow-maint/search
Cashflow Forecasting Services/Cashflow Transaction Service API
This service provides the channel request for cashflow transaction, Delete unauthorised transaction, KAFKA call back and fetching distinct cashflow transaction codes.
- Authorizes cashflow transaction
- Method: postPath:
/service/v1/authorizeCashflowTxn
- Creates a new cashflow transaction
- Method: postPath:
/service/v1/cashflowInflowTxns
- Delete the unauthorized cashflow transactions
- Method: postPath:
/service/v1/deleteUnAuthCashflowTxn
- Retrieves cashflow codes
- Method: getPath:
/service/v1/cashflowCodes
- Update cashflow transaction status after Projection update
- Method: postPath:
/service/v1/updateCashflowTxnStatus
Cashflow Projection Services/Cashflow Inquiry Service API
This service provides the APIs to perform Cashflow Inquiry.
- Fetches the list of cashflows
- Method: getPath:
/obcm-cashflow-projection-services/service/v1/cashflow-maint/search
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 the actual and predicted Cashflows Data
- Method: getPath:
/service/v1/cashflowSummary
- Retrieves the Cashflow Forecast Report
- Method: getPath:
/service/v1/cashflowForecasting
- Retrieves the Cashflow Transaction Data
- Method: getPath:
/service/v1/nested/cashflowForecasting
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: getPath:
/service/v1/collectionChartData
- Retrieves the Instrument Collection data
- Method: getPath:
/service/v1/collectionChequeData
Charge Services/Charge Enquiry Service API
This service provides APIs to create, update, calculate and inquiry of charges.
- Authorize the charges transaction data
- Method: getPath:
/service/v1/approveCharges
- Calculate and create the cash deposit charges transaction details record
- Method: postPath:
/service/v1/cashDepositTxn
- Calculate and create the instrument collection charges transaction details record
- Method: postPath:
/service/v1/chequeDepositTxn
- Calculate the charges
- Method: postPath:
/service/v1/charges
- Create the charges transaction details record
- Method: postPath:
/service/v1/postChargesTxnData
- Create the finance transaction details record
- Method: postPath:
/service/v1/postFinanceTxnData
- Create the invoice transaction details record
- Method: postPath:
/service/v1/postInvoiceTxnData
- Create the purchase order details record
- Method: postPath:
/service/v1/postPoTxnData
- Fetch the authorized transaction details for charges
- Method: getPath:
/service/v1/getTxnDetails
- Fetch the charges details
- Method: getPath:
/service/v1/chargeEnquiry
- Fetch the charges transaction data
- Method: getPath:
/service/v1/chargesTxnData
- Process the charge transaction data and calculates charges for periodic charge transaction data
- Method: getPath:
/service/v1/batchChargesTxnData
- Update the charges transaction data for the given id
- Method: patchPath:
/service/v1/chargesTxn/{id}
Charge Services/Charge Pricing Template Service API
This service provides the inquiry APIs for charges pricing templates.
- Fetch the preferential pricing templates
- Method: postPath:
/service/v1/getPrefChargeDetails
- Fetch the pricing categories
- Method: getPath:
/service/v1/prcCategory
- Fetch the pricing templates
- Method: postPath:
/service/v1/getChargeDetails
- Fetch the pricing templates for given pricing category
- Method: getPath:
/service/v1/prcMethods
Collections Maintenance Services/Arrangement Decisioning Service API
This service provides the Inquiry APIs for Arrangement Decisioning maintenance.
- Fetch all the arrangement decisioning maintenance
- Method: getPath:
/service/v1/decisioningmaster
- Fetch the arrangement days
- Method: postPath:
/service/v1/arrangementDecisioning/arrangementDays
- Fetch the arrangement decisioning maintenance by given ID
- Method: getPath:
/service/v1/decisioningmaster/{id}
Collections Maintenance Services/Bank Branch Service API
This service provides the API information for bank branch operations.
- Fetch the core branch details
- Method: postPath:
/service/v1/corebranch/getByLocList
- Fetch the list of bank branch details
- Method: getPath:
/service/v1/bankbranch
Collections Maintenance Services/Cash Denominations Service API
This Service provides the inquiry APIs for cash denomination maintenances.
- Fetch the list of denomination details
- Method: getPath:
/service/v1/getCCYDenominationDetails
- Fetch the list of distinct branch codes from denomination details
- Method: getPath:
/service/v1/distinctBranchCode
Collections Maintenance Services/Cash and Instrument Product API
- Fetch all products of Cash and Instrument collections with description
- Method: getPath:
/service/v1/product/productWithDesc
- Fetch the product by product code and branch code
- Method: getPath:
/service/v1/product/{productCode}/{branchCode}
- Fetch the product by product type and network type
- Method: getPath:
/service/v1/productSearch
- Fetch the products of Cash and Instrument collections
- Method: getPath:
/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: getPath:
/service/v1/corporateinformation/enrichment
- Fetch the corporate enrichment pooling details
- Method: getPath:
/service/v1/corporateinformation/poolingsetup
- Fetch the corporate enrichment products
- Method: getPath:
/service/v1/corporateinformation/products
- Update the pickup and delivery details for an existing corporate enrichment record
- Method: postPath:
/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: getPath:
/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: getPath:
/service/v1/locationCluster
- Fetch the location cluster by location clusterCode
- Method: getPath:
/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: getPath:
/service/v1/location/corrbanks/{locationCode}
- Fetch the list of locations maintained
- Method: getPath:
/service/v1/location
- Fetch the list of outside network bank setup for location code
- Method: getPath:
/service/v1/location/osnwbanks/{locationCode}
- Fetch the location details by location code
- Method: getPath:
/service/v1/locationmaster/{locationCode}
- Fetch the location setup by location code
- Method: getPath:
/service/v1/location/{locationCode}
Collections Maintenance Services/Routing Service API
This service provides the inquiry API for Routing information.
- Fetch the list of routing data
- Method: getPath:
/service/v1/routing
Collections Transaction Services/Cash Deposit Service API
This service provides the APIs for Cash Deposit creation and inquiry and duplicate deposit slip number validation.
- Create the cash deposit slip transaction
- Method: putPath:
/service/v1/denominationCollection/update
- Fetch the cash deposit slip data
- Method: getPath:
/service/v1/cashDepositInquiry
- Validate the cash deposit slip number
- Method: getPath:
/service/v1/cashDeposit/duplicateValidation/{depositSlipNo}/{corporateId}
Collections Transaction Services/Cash Withdrawal API
This service provides the APIs for Cash Withdrawal creation and inquiry.
- Authorize the cash withdrawal entry
- Method: postPath:
/service/v1/authorizeWithdrawal
- Create the cash withdrawal transaction
- Method: putPath:
/service/v1/cashWithdrawalInquiry
- Fetch the list of cash withdrawals
- Method: getPath:
/service/v1/cashWithdrawalInquiry
- Reject the cash withdrawal entry
- Method: postPath:
/service/v1/rejectWithdrawal
Collections Transaction Services/Instrument Collection API
This service provides the APIs for Instrument collection creation, inquiry and duplicate deposit slip number/instrument number validation.
- Create the Instrument collection transaction
- Method: putPath:
/service/v1/instrumentCollection/update
- Fetch the Instrument collection data
- Method: getPath:
/service/v1/instrumentEnquiry
- Fetch the list of Instrument collection transaction
- Method: getPath:
/service/v1/instrument
- Validate the Instrument Number and Deposit Slip Number
- Method: getPath:
/service/v1/instrumentCollection/duplicateCheck
Collections Transaction Services/Payment Integration API
This service provides the APIs for external payment integration.
- Notification API to be consumed by external payment integration to send instrument clearing status
- Method: postPath:
/service/v1/clearingStatusNotification
Core Services/Division Code Service API
This service is used for Customer Division Code Operations.
- Adds a new division code
- Method: postPath:
/service/v1/divisioncode/division
- Deletes/Closes a new division code
- Method: patchPath:
/service/v1/divisioncode/division
- Get all valid division code
- Method: getPath:
/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: putPath:
/service/v1/noncustomers/{relRefId}/approve
- Generate Non Customer ID
- Method: getPath:
/service/v1/generateNonCustId
- Get all valid Non Customer
- Method: getPath:
/service/v1/noncustomer
- Get all valid Non Customer code
- Method: getPath:
/service/v1/getNonCustomerCode
- Modify counter party if exist
- Method: putPath:
/service/v1/noncustomer
- On boards Counter Party
- Method: postPath:
/service/v1/noncustomers
- On boards Counter Party
- Method: putPath:
/service/v1/noncustomers
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.
- Filters the payment terms by given input parameters
- Method: postPath:
/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.
- Adds a new relationship master
- Method: postPath:
/service/v1/relationshipmaster/noncustomer
- Check expiry of each relationship at the end of the day
- Method: getPath:
/service/v1/checkRelationshipExpiry
- Fetch Counter Party Details for given External Code
- Method: getPath:
/service/v1/relationshipmaster/nonCustomerDetails/{externalCode}
- Fetch relationship master for given relationship code.
- Method: getPath:
/service/v1/relationshipmaster/associatedParty
- Fetch the external code for given associated party
- Method: getPath:
/service/v1/relationshipmaster/externalCode
- Fetch the relationship master for given associated party
- Method: getPath:
/service/v1/relationshipmaster/associatedPartiesList
- Get all valid relationship master
- Method: getPath:
/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.
- Adds a new relationship master
- Method: postPath:
/service/v1/relationshipRecords
Core Services/Relationship Service API
This service is used to perform operations on Relationship.
- Fetch the existing Relationships between Associated parties.
- Method: getPath:
/service/v1/getRelationships
Core Services/Supplier Commodity Service API
This service is for commodity operations.
- Adds a new supplier commodity code
- Method: postPath:
/service/v1/scommodity
- Get all valid supplier commodity code
- Method: getPath:
/service/v1/scommodity
Filter Services/Filter Service API
This Service is used for Filter Operations.
- Filter Input
- Method: postPath:
/service/v1/filterValues
- Gives the attribute name for given attribute value
- Method: postPath:
/service/v1/filterNames
- Retrieves Filter Criteria Query
- Method: getPath:
/service/v1/filterQuery
Instruments Receivables Services/Credit Note Service API
This service is used for Credit Note Service layer Operations.
- Authorize Credit Note
- Method: postPath:
/service/v1/authorizeCreditNote
- Create new credit note from external channels
- Method: postPath:
/service/v1/createCreditNote
- Create new credit note V2 from external channels
- Method: postPath:
/service/v2/createCreditNote
- Deletes corresponding data upon Transaction Purge
- Method: postPath:
/service/v1/purgeCrnTransaction
- Retrieves current unauthorised credit note
- Method: getPath:
/service/v1/getUnauthTwCreditNoteRecord
- Retrieves the list of existing credit notes
- Method: getPath:
/service/v1/creditNoteSearch
- Updates the list of existing credit notes
- Method: putPath:
/service/v1/updateCreditNote
- Updates the list of existing credit notes
- Method: putPath:
/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: getPath:
/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: postPath:
/service/v1/invoiceprocess
Instruments Receivables Services/Invoicing Service API
This service is used for Invoice Operations.
- Acquire invoice task
- Method: getPath:
/service/v1/acquireInvoiceTask
- Adds a main Invoices after validation
- Method: putPath:
/service/v1/authorizeInvoices
- Adds a new Invoice in main table.
- Method: postPath:
/service/v1/invoice
- Adds a new invoice in stage table.
- Method: postPath:
/service/v1/stageInvoice
- Approve instruments in workflow
- Method: postPath:
/service/v1/invStageApprove
- Authorise invoice from conductor
- Method: postPath:
/service/v1/authorizeInvoice
- Batches the selected invoice files
- Method: postPath:
/service/v1/autoInvoiceBatch
- Batches the selected Invoice files
- Method: postPath:
/service/v1/initiateInvoiceFinance
- Creates a new invoice margin record
- Method: postPath:
/service/v1/invoiceMarginCalc
- Enrich the invoice with necessary fields for creation
- Method: postPath:
/service/v1/enrichment
- Evicts business date cache
- Method: getPath:
/service/v1/refreshBusinessDate
- Find overdue invoices
- Method: getPath:
/service/v1/overdueInvoice
- Find stale invoices
- Method: getPath:
/service/v1/staleInvoice
- Generates the finance reference number
- Method: getPath:
/service/v1/generateFinanceRefNo
- Generates the margin reference number for a particular invoice
- Method: getPath:
/service/v1/generateMarginRefNo
- Get file status By file name
- Method: getPath:
/service/v1/getFileStatusByFileName
- Get Invoices by Transaction Ref No from TM
- Method: getPath:
/service/v1/getInvoiceMaintByTxnRefNo
- Invoice Approval Marking
- Method: getPath:
/service/v1/eod/limitsInvoiceApprovalMarking
- Payment Incoming 2nd stage Invoice Validation
- Method: getPath:
/service/v1/paymentIncomingInvoiceValidation
- Populate adhoc transaction details
- Method: postPath:
/service/v1/setAdhocTxnDetails
- Process margin handling
- Method: postPath:
/service/v1/processMarginHandling
- Process margin refund
- Method: postPath:
/service/v1/createMarginRefundPmt
- Process margin refund
- Method: postPath:
/service/v1/marginRefundPmt
- Process margin refund
- Method: postPath:
/service/v1/postMarginAccEntries
- Process margin refund
- Method: postPath:
/service/v1/processMarginRefund
- Reject instruments
- Method: postPath:
/service/v1/purgeTransaction
- Retrieves the Invoice Finance Info for a particular Invoice
- Method: getPath:
/service/v1/finances/{invoiceRefNo}
- Retrieves the Invoices for a particular Finance Transaction
- Method: getPath:
/service/v1/invoices/{financeRefNo}
- Retrieves the list of existing debit notes
- Method: getPath:
/service/v1/debitNoteSearch
- Retrieves the list of existing Invoices
- Method: getPath:
/service/v1/getCurrentInvoceByInvRefNo
- Retrieves the list of existing Invoices
- Method: getPath:
/service/v1/invoice
- Retrieves the list of existing invoices
- Method: getPath:
/service/v1/invoiceSearch
- Retrieves the list of existing invoices
- Method: getPath:
/service/v1/processFutureDatedDisbursement
- Retrieves the list of existing Tags
- Method: getPath:
/service/v1/tags
- Retrieves the list of Finance reference number for given RequestId
- Method: getPath:
/service/v1/getInvoiceFinanceRefNos
- Returns Discrepancy Code
- Method: getPath:
/service/v1/getDiscrepancyCode
- Runs invoice acceptance job
- Method: getPath:
/service/v1/runInvoiceAcceptanceJob
- Update existing Invoices
- Method: patchPath:
/service/v1/linkPrograms
- Update existing invoices
- Method: patchPath:
/service/v1/mainInvoice
- Update invoice in settlement
- Method: putPath:
/service/v1/genericUpdate
- Update invoice in settlement
- Method: putPath:
/service/v1/settlementStatusUpd
- Update outstanding values in invoice
- Method: postPath:
/service/v1/updateInvOutstandings
- Updates a Invoice in main table
- Method: putPath:
/service/v1/invoice/{invoiceRefNo}
- Updates Debit Note in Tw table
- Method: putPath:
/service/v1/debitNote
- Updates Invoices in main table
- Method: putPath:
/service/v1/invoice
Instruments Receivables Services/Payment Service API
This service provides APIs to perform operations on Payment Transactions.
- Authorize the Payment transaction
- Method: postPath:
/service/v1/authorizePayment
- Create the authorized Payment transaction through Netting
- Method: postPath:
/service/v1/nettingPaymentTm
- Create the excess payment for a reconciliation transaction
- Method: postPath:
/service/v1/checkForExcessPayment
- Create the new Payment in stage table
- Method: postPath:
/service/v1/stagePayment
- Create the Payment transactions
- Method: postPath:
/service/v1/payments
- Fetch the Excess Payment handling parameters
- Method: getPath:
/service/v1/getExcessHandlingParameters
- Fetch the Excess Payment transaction details
- Method: getPath:
/service/v1/excessPaymentInq
- Fetch the Payment transaction details from work table on basis of Payment Number
- Method: getPath:
/service/v1/paymentTwSearchByNumber
- Fetch the Payment transactions
- Method: getPath:
/service/v1/paymentSearch
- Fetch the payment transactions from main table on the basis of Payment Reference Number
- Method: getPath:
/service/v1/getPaymentByPayRefNo
- Fetch the Payment transactions from work table
- Method: getPath:
/service/v1/paymentTwSearch
- Fetch the payment transactions from work table on the basis of Payment Reference Number
- Method: getPath:
/service/v1/getPaymentTwByPayRefNo
- Fetch the Payment transactions which are in Processing state
- Method: getPath:
/service/v1/getCurrentTwPayment
- Post the payments from the stage to the main table after validation
- Method: postPath:
/service/v1/mainPayment
- Purge the payment transactions
- Method: postPath:
/service/v1/purgePmtTransaction
- Roll back Payment Invoice Tw Tm For Netting Failure
- Method: postPath:
/service/v1/rollBackPaymentInvoiceTwTm
- Roll-back the amount and status for payment and credit note
- Method: postPath:
/service/v1/purgeInstrumentsRecon
- Update the payment data after Invoice Payment Reconciliation
- Method: patchPath:
/service/v1/invPayRecon
- Update the Payment status after allocation
- Method: postPath:
/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: getPath:
/service/v1/poCharges
Instruments Receivables Services/Purchase Order Service API
This service is for Purchse Order Operations.
- Adds a new Purchase Order
- Method: postPath:
/service/v1/po/create
- Authorise purchase order from conductor
- Method: postPath:
/service/v1/po/authorizePo
- Enrich the purchase oder with necessary fields for creation
- Method: postPath:
/service/v1/po/enrichment
- Modify a existing authorised Purchase Order
- Method: postPath:
/service/v1/po/modify
- Purchase Order Link Program
- Method: patchPath:
/service/v1/po/linkProgram
- Reject instruments
- Method: postPath:
/service/v1/po/rejectPo
- Retrieves the List of purchase order linked to the finance
- Method: getPath:
/service/v1/po/linkedPOs/{financeRefNo}
- Retrieves the purchase order finance info for a particular purchase order
- Method: getPath:
/service/v1/poFinance/{financeRefNo}
- Runs purchase order acceptance job
- Method: getPath:
/service/v1/runPOAcceptanceJob
- Search for an existing purchase order
- Method: getPath:
/service/v1/po
Manual Reconciliation Services/Auto Reconciliation Rules API
This service provides the API for creation of Reconciliation rules.
- Creates a new Reconciliation Rule
- Method: postPath:
/service/v2/autoRecon
Manual Reconciliation Services/Auto Reconciliation Service API
This service provides APIs for fetching Reconciliation rule details.
- Fetch the Reconciliation rule details
- Method: getPath:
/service/v1/getReconRuleDetails
- Get all Rule Set
- Method: getPath:
/service/v1/reconExecRules
- Get all the valid Rule Set
- Method: postPath:
/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.
- Create the new manual allocation transaction
- Method: postPath:
/service/v1/initiateManualAlloc
- Create the new reconciliation transaction
- Method: postPath:
/service/v1/initiateManualRecon
- Fetch the manual allocation transaction detail
- Method: postPath:
/service/v1/getManualAlloc
- Fetch the reconciliation transaction detail
- Method: getPath:
/service/v1/getReconTmData
- Fetch the reconciliation transaction details
- Method: postPath:
/service/v1/getManualReconDetails
- Initiate the new dereconciliation transaction
- Method: postPath:
/service/v1/initiateManualDerecon
Manual Reconciliation Services/Reconciliation Rule Service API
This service provides APIs to fetch Reconciliation categories and post Allocation.
- Fetch the reconciliation categories based on given parameters
- Method: getPath:
/service/v1/reconAttributes
- Fetch the reconciliation categories for a specific language
- Method: getPath:
/service/v1/reconCategories
- Initiate a new allocation transaction
- Method: postPath:
/service/v1/postAllocation
Manual Reconciliation Services/VAM Reconciliation Service API
This service provides the API to fetch the VAM account based on given parameters.
- Fetch the VAM account based on given parameters
- Method: postPath:
/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: getPath:
/service/v1/product/externalProduct
- Get the valid delinquency status
- Method: getPath:
/service/v1/product/delinquencyStatus
- Retrieves OBCM Application Parameters
- Method: getPath:
/service/v1/cm/appParams
- Retrieves Reference Number Generation Parameters
- Method: getPath:
/service/v1/getRefNoGenParams
- Retrieves scf Application Parameters
- Method: getPath:
/service/v1/appParams
- Retrieves SCF Master Party Parameters
- Method: getPath:
/service/v1/parties
- Retrieves SCF System Parameters
- Method: getPath:
/service/v1/sysParams
- Update an existing parameter
- Method: patchPath:
/service/v1/sysParams/{key}
Netting Service/Netting Structure Service API
This service is used for Netting Structure Services Operations.
- Fetch the in-progress Structure edits from Channel for a subsidairy
- Method: getPath:
/service/v1/getAllChnlReqEnrichParamDtls
- Retrieves the Netting Structure for a party ID
- Method: getPath:
/service/v1/getStructureTree
- Retrieves the Enrich Params based on party IDs and party types
- Method: getPath:
/service/v1/getStructureEnrichParams
- Updates the Netting Structure for a particular structure
- Method: putPath:
/service/v1/updateStructureTree
Netting Service/Netting Transactions Service API
This Service is used for Netting Transactions Operations.
- Approve, Reject or Purge transaction based on stage from conductor
- Method: postPath:
/service/v1/approveRejectNettingMgmtTxn
- Create the transaction for the eligible structures
- Method: getPath:
/service/v1/runEligibilityJob
- Retrieves the list of associated receivables and payables
- Method: getPath:
/service/v1/netInvDetForNettMgmt
- Retrieves the list Of existing subsidiaries for a transaction
- Method: getPath:
/service/v1/getAllSubsidiaries
- Retrieves the list of Netting Transactions
- Method: getPath:
/service/v1/getNettingInquiry
- Retrieves the list of Netting Transactions
- Method: getPath:
/service/v1/getTxnsForNettingMgmt
- Retrieves the list of pay out transactions
- Method: getPath:
/service/v1/payInOutListing
- Retrieves the Netting Management Basic Information and Fx Details
- Method: getPath:
/service/v1/netTxnsDetForNettMgmt
- Update the Netting Transaction received from Channel
- Method: putPath:
/service/v1/netTxnsDetForNettMgmt
- Updates Netting Transactions Status via nettingAcceptanceJob Job
- Method: getPath:
/service/v1/nettingAcceptanceTxn
- Updates the latest Fx Rates and Amounts for Netting Transactions
- Method: getPath:
/service/v1/updateFxRates
Payment Service APIs
The operations from the Payment Service APIs category.
- Create the Payment transaction in work table through Netting
- Method: postPath:
/service/v1/nettingPaymentTw
Report Services/Event Service API
This service provides APIs for Event Data Management.
- Save credit note data received through events
- Method: postPath:
/service/v1/saveCreditNote
- Save invoice data received through events
- Method: postPath:
/service/v1/saveInvoiceData
- Save payment data received through events
- Method: postPath:
/service/v1/savePaymentData
- Save uploaded file data received through events
- Method: postPath:
/service/v1/saveUploadedFileData
Report Services/Relationship Service API
This service provides APIs for maintaining relationships between corporates and their buyers and sellers.
- Saves a new relationship master
- Method: postPath:
/service/v1/saveRelationshipData
Workflow Managenent Services/Conductor Service
This service is used for interface between conductor and service.
- Initiates the workflow from the conductor
- Method: postPath:
/service/v1/initiateWorkflow
- Interface to handle HTTP Task from Conductor
- Method: postPath:
/service/v1/handleHTTPTask
- Updates the manual task from the conductor
- Method: postPath:
/service/v1/updateManualTask