PaymentCollectionRun

This component runs the Payment Collection Run (PYC) process.

It is used to settle the debit transactions.

Methods

Process
Driver Type: SASI
Use this method to run the component.
Note: Whereas SunSystems prompts you for the reporting option (whether to Print, Store or View), SSC only allows Print or Store to be used. The SSC default is Store. The report, by default, is stored in the SunSystems \Output folder. This location can be changed.
Parameters can be added to control the clearing of previous payments/remittances:
  • ClearPrevious - set to Y if previous payments/remittances are to be cleared down (if they exist).
  • ClearPreviousBank - set to Y if Bank Payments are to be cleared down (if they exist).
These should be included in the <AdditionalParameters> section of the payload.
The default is that no previous payments/remittances will be cleared.

Mandatory fields

  • A value must be supplied for the input parameter: Payment Collection Run Profile Code - payload element <ProfileCode>.
  • If you want to run a payment run using a particular document format, a value must be supplied for the Document Format Code - payload element <DocumentFormatCode>.
Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

Document Formats.