Service Directory > v29.2 > Settlement_Services

 

Web Service: Settlement_Services (v29.2)

Web Service used for settlement management and services.

Version

Operations

Operation Description
Get_Escheatment_Items This Web Service Task allows you to get Escheatment Items based on ID or a combination of company, payment status, and date 
Get_Payment_Messages This service operation will get Payment Messages for the specified criteria. The request criteria can be for a single payment message based on Reference, or all payment messages for the specified criteria. 
Get_Payment_Types This service operation will get Payment Type data for the specified criteria. Data includes ID, Payment Type Name, and Payment Method. The request criteria can be for a specific Payment Type based on reference(s), Payment Type Name (partial match ok), and Payment Method criteria. If no criteria are specified, all Payment Types will be retrieved. 
Get_Payments This service operation will get Payments for the specified criteria. The request criteria can be for a single payment based on Reference, or all payments for a specified company. 
Get_Settlement_Run_Custom_Filters This service operation will get Settlement Run Custom Filters for the specified criteria. The request criteria can be for a single Settlement Run Custom Filter based on Reference, or all Settlement Run Custom Filters 
Get_Stop_Items This Web Service Task allows you to get Stop Items based on ID, or a combination of organization, stop item status, stop date, payment, payee, payment category, and the payment reference number. 
Put_Escheatable_Payment_Notification_Date Update Payment Notification Date for an Escheatable Payment 
Put_Payment_Acknowledgement_Message This service operation will add or update Payment Acknowledgements or Payment File Acknowledgements providing updates to existing payment status and error code information. 
Put_Payment_Type This service operation will add or update Payment Type. Data includes ID, Payment Type Name, and Payment Method. 
Put_Settlement_Run_Custom_Filter This Web Service allows you to update or add a new Settlement Run Custom Filter. 
Submit_Escheatment_Items This Web Service allows you to update or add a new escheatment Item to a payment 
Submit_Settlement_Run Web service for creating a settlement run. 
Submit_Stop_Items This Web Service Task allows you to add a new Stop Item to a payment.