Table of Contents

• About the REST APIs
• All REST Endpoints

Tasks

• Account Maintenance Services
  • Accounting Service API
    • Add a new accounting entry code
    • Authorize the accounting entry code
    • Delete the accounting entry code by ID
    • Fetch the accounting transaction details
    • Get all account details
    • Get all accounting details
    • Get all accounting entries
    • Get all accounting numbers
    • Get all valid accounting entry code
    • Get party based on the account number
    • Get party Id
    • Retrieves the internal account mapping
    • Update external system response status
  • Pooling Accounting Service API
    • Get account number
    • Process accounting entries and authorize for pooling tasks
• Alerts services
  • Alert Category Service API
    • Updates alert category
• Cashflow Forecasting Services
  • Cashflow Inquiry API
    • Fetches the list of cashflow transactions
  • Cashflow Transaction Service API
    • Authorize cashflow transaction
    • Create a new cashflow transaction
    • Delete the unauthorized cashflow transactions
    • Fetch the distinct cashflow codes
    • Update cashflow transaction status after projection update
• Cashflow Projection Services
  • Cashflow Inquiry Service API
    • Fetches the list of cashflow transactions
  • Cashflow Report Service API
    • Retrieves cashflow transaction data
    • Retrieves predicted cashflows forecasting data
    • Retrieves the cashflow forecast report
    • Retrieves the predicted cashflows data
• Cashflow Report Service
  • Report Service API
    • Retrieves the cash deposit and cash withdrawal data
    • Retrieves the instrument collection data
• Charge Services
  • Charge Enquiry Service API
    • Authorizes the charges transaction data
    • Calculate the charges for periodic charge transaction data
    • Calculates and creates cash deposit charges transaction
    • Calculates and creates instrument collection charges transaction
    • Calculates the charges
    • Create cash withdrawal charges transaction
    • Create the charges transaction details
    • Creates purchase order details
    • Creates the invoice transaction details
    • Fetch charge details
    • Fetch the authorized transaction details
    • Fetch the charges transaction data
    • Update the charges transaction data for the given id
  • Charge Pricing Template Service API
    • Fetch pricing templates for given pricing category
    • Fetch the preferential pricing templates
    • Fetch the pricing categories
    • Fetch the pricing templates
• CollectionChargesService
  • Online charges for Cash Collection
• Collections Maintenance Services
  • Arrangement Decisioning Service API
    • Fetch all the arrangement decisioning maintenance
    • Fetch the arrangement days
    • Fetch the arrangement decisioning maintenance
  • Bank Branch Service API
    • Fetch the core branch details
    • Fetch the list of bank branch details
  • Cash and Instrument Product API
    • Fetch all products of cash and instrument collections with description
    • Fetch the product by product code and branch code
    • Fetch the product by product type and network type
    • Fetch the products of cash and instrument collections
  • Cash Denominations Service API
    • Fetch the list of denomination details
    • Fetch the list of distinct branch codes from denomination details
  • Corporate Information Service API
    • Fetch the corporate enrichment data
    • Fetch the corporate enrichment pooling details
    • Fetch the corporate enrichment products
    • Update the pickup and delivery details for a corporate
  • Courier Setup Service API
    • Fetch the courier setup maintained
  • Location Cluster Service API
    • Fetch the list of location clusters
    • Fetch the location cluster by location cluster code
  • Location Service API
    • Fetch the list of correspondant bank setup for location code
    • Fetch the list of locations maintained
    • Fetch the list of outside network bank setup for location code
    • Fetch the location details by location code
    • Fetch the location setup by location code
  • Routing Service API
    • Fetch list of routing data
• Collections Transaction Services
  • Arrangement Details and Pooling Date
    • Identify arrangement and pooling date
  • Batch Service
    • Batch transaction
    • Reject batch transaction for rework
  • Cash Deposit Service API
    • Create the cash deposit slip transaction
    • Fetch the cash deposit slip data
    • Process pooling of existing cash transactions
    • Validate the cash depositSlip number
  • Cash Withdrawal API
    • Authorize the cash withdrawal entry
    • Create the cash withdrawal transaction
    • Fetch the list of cash withdrawals
    • Reject the cash withdrawal entry
  • Charge calculation API
    • Collection charges
    • Online charges for Cheque Collection
  • Instrument Collection API
    • Create the instrument collection transaction
    • Fetch the instrument collection data
    • Fetch the list of instrument collection transaction
    • Process general ledger accounting
    • Process pooling of an existing instruments
    • Send the outward clearing request
    • Validate the instrument number and deposit slip number
  • Instrument Management Service API
    • Purge instrument management transaction
    • Reject instrument management transaction
  • Payment Integration API
    • Send the instrument clearing status notification
• Core Services
  • Division Code Service API
    • Adds a new division code
    • Deletes/closes a new division code
    • Fetch division code basis of given Rel code, program Code, associated Party and division code/name
    • Get all valid division code
  • Non-Customer Service API
    • Authorize the non-customer
    • Generate non-customer ID
    • Get all valid non customer
    • Get all valid non-customer code
    • Modify non-customer details
    • Modify the counter party
    • Onboard a new non-customer
  • Non-Customer Service V2 API
    • Create a new non-customer
    • Get all valid non customer
    • Update the non-customer data
  • Payment Terms Service API
    • Maintain the specific payment frequencies and dates for buyers
  • Relationship Master Service API
    • Add a new relationship record
    • Check the expiry of each relationship at the end of the day
    • Fetch relationship master for given associated party
    • Fetch the counter party details for given external code
    • Fetch the external code for given associated party
    • Fetch the relationship master for given relationship code
    • Fetch the relationship record for given associated party
    • Get all valid relationship record
  • Relationship Records Service API
    • Add a new relationship master
  • Relationship Service API
    • Fetch the existing relationships between associated parties
  • Supplier Commodity Service API
    • Adds a new supplier commodity code
    • Get all valid supplier commodity code
• Filter Services
  • Filter Service API
    • Fetch the attribute name
    • Filter the input
    • Retrieve the filter criteria query
• Instruments Receivables Services
  • Credit Note Service API
    • Authorize the credit note
    • Create new credit note from external channels
    • Create new credit note from external channels (V2)
    • Deletes corresponding data upon transaction purge
    • Retrieves the current unauthorised credit note
    • Retrieves the list of existing credit notes
    • Updates the list of existing credit notes
    • Updates the list of existing credit notes (V2)
  • Discount Offer Service API
    • Create the discount offers
    • Retrieves the list of discount offers
    • Retrieves the list of discount offers history
  • Invoice Charges Service API
    • Calculate the online charges for invoices
  • Invoice Process Service API
    • Performs invoice actions based on workflow task
  • Invoicing Service API
    • Acquire invoice task
    • Add a main invoices
    • Add a new invoice in main table
    • Add a new invoice in stage table
    • Approve instruments
    • Authorise invoice from conductor
    • Auto assign invoice
    • Enrich the invoice
    • Evict business date cache
    • Get edit invoice details
    • Get invoices by transaction reference number
    • Instrument work update
    • Instruments payments status
    • Overdue invoices
    • Payment incoming
    • Populate adhoc transaction
    • Reject instruments
    • Retrieve the list of current invoices by invoice reference number
    • Retrieve the list of existing debit notes
    • Retrieve the list of existing invoices
    • Retrieve the list of existing tags
    • Retrieve the list of historical status
    • Retrieves the list of existing invoices with input parametes
    • Return discrepancy code
    • Run invoice acceptance job
    • Stale invoices
    • Update a invoice in main table
    • Update debit note
    • Update existing invoices
    • Update invoice in settlement
    • Update invoices in main table
    • Update outstanding values
    • Update settlement status for invoice
    • Updates invoice status
  • Invoicing Service V2 API
    • Adds a new invoice in main table
    • Retrieves the list of existing invoices
    • Updates the invoices in work table
  • Invoicing Service V3 API
    • Get linked invoices
    • Retrieves the list of existing invoices
    • Retrieves the status of existing invoices
    • Updates invoices
  • Payment Service API
    • Authorizes the Payment transaction
    • Creates authorized payment transaction
    • Creates payment transaction in work table
    • Creates the payment transactions
    • Excess payment transaction details
    • Fetch the payment transactions by reference number
    • Fetches the payment transaction details
    • Fetches the payment transactions
    • Fetches the payment transactions by given parameters
    • Fetches the payment transactions from work table
    • Fetches the payment transactions in processing state
    • New payment in stage table
    • Payment data after invoice payment reconciliation
    • Payment for reconciliation transaction
    • Payment handling parameters
    • Posts payments from the stage to the main table
    • Purge payment transactions
    • Roll back payment invoice
    • Rolls-back the amount and status
    • Update payment
    • Update payment work
    • Updates the payment status
  • Purchase Order Charges Service API
    • Calculate the online charges for purchase orders
  • Purchase Order Service API
    • Adds a new Purchase order
    • Authorise purchase order from conductor
    • Edit an existing authorised Purchase order
    • Enrich the purchase order
    • Existing purchase order
    • Get edit PO details
    • Get PO details by PO internal number
    • Linked purchase order by Invoice reference number
    • Modify a existing authorised Purchase order
    • Reject instruments
    • Retrieve and process the list of existing POs
    • Retrieve the list of purchase orders
    • Retrieve the list of purchase orders
    • Run purchase order acceptance job
  • Refund Service API
    • Authorizes steps from refund Process
    • Captures success response of payment
    • Processes steps from purge refund
    • Processes steps from refund process
    • Runs payment refund job
• Manual Reconciliation Services
  • Auto Reconciliation Service API
    • Creates a new reconciliation rule
    • Get all reconciliation rule details
    • Get reconciliation rule definition details
  • Auto Reconciliation Service V2 API
    • Creates a new reconciliation rule
    • Fetches reconciliation rule details
    • Get all rule set
    • Get all the valid rule set
  • Manual Reconciliation Service API
    • Check for pending transactions
    • Creates the new manual allocation transaction
    • Creates the new reconciliation transaction
    • Fetches authorized reconciliation transaction details
    • Fetches the manual allocation transaction details
    • Fetches the reconciliation transaction details
    • Initiates the new dereconciliation transaction
    • Retry exception queue manual recon transactions
    • Validate reconciliation details
  • Reconciliation Rule Service API
    • Fetch the reconciliation categories
    • Fetch the reconciliation categories for a specific language
    • Initiate a new allocation transaction
• Master Maintenance Services
  • Master Maintenance Service API
    • Get all valid external system product code
    • Get the valid delinquency status
    • Retrieves the cash management application parameters
    • Retrieves the reference number generation parameters
    • Update an existing parameter
• Netting Service
  • Netting Structure Service API
    • Fetch the enrich details for the subsidiary
    • Retrieve all the netting structures
    • Retrieve the netting structure
    • Retrieve the enrichment parameters
    • Update the netting structure
  • Netting Transactions Service API
    • Approve/Reject the netting transaction
    • Create the netting transaction
    • Fetch the list of netting inquiry transactions
    • Generate and post accounting entries
    • Initiate pay in out for a transaction
    • Recalculation of payin-payout
    • Retrieve the list of netting transactions
    • Retrieve the list of pay out transactions
    • Retrieves the list of associated receivables and payables
    • Retrieves the list of netting transactions details based on type
    • Retrieves the list of subsidiaries linked to the netting transaction
    • Retrieves the list of transactions for netting management
    • Retrieves the netting management basic information and Fx details
    • Update the netting transaction received from Channel
    • Update the netting transaction status as accepted
    • Updates the latest Fx rates and amounts for netting transactions
• Workflow Management Services
  • Conductor Service
    • Get fact data
    • Initiates the workflow from the conductor
    • Interface to handle HTTP task from conductor
    • Updates the manual task from the conductor