Prerequisites

To setup the freeze payments on notification process, you need to do the following:

• Define the automatic payment instructions for the account for which you want to enable the automatic payment option.

  Note: You can either define non-rule based effective dated automatic payment instructions in the Auto Pay tab of the Account screen or define rule based effective dated automatic payment instructions through the Auto Pay Rule screen.

• Set the Autopay Creation Option field to Freeze Payment on Notification in the Billing tab of the Installation Options screen.

• Create an automatic payment creation algorithm using the APAY-CREATE algorithm type and attach it to the Automatic Payment Creation system event in the Algorithms tab of the Installation Options - Framework screen.

• Create an automatic refund creation algorithm using the C1-AREF-CRET algorithm type and attach it to the Automatic Adjustment Creation system event in the Algorithms tab of the Installation Options - Framework screen.

• Create a date calculation algorithm using the APAY-DTCALC algorithm type and attach it to the Autopay Date Calculation Alg spot of the auto pay route type which is specified on the account's automatic payment instruction.

• Define the required upload reasons in the system.

• Define the required payment cancelation reasons in the system.

• Define values for the APAY_​UPL_​NOC_​LOOKUP lookup field.

  Note: The APAY_​UPL_​NOC_​LOOKUP lookup field is used to define NOC reasons. The NOC reason specified in the automatic payment clearing staging record must exists in this lookup field and its status must be Active. Otherwise, the status of the automatic payment clearing staging record is changed to Error.

• Define voided status reasons for the C1-RefundReq business object.

• Create an automatic payment success algorithm using the C1-APAY-SUCC algorithm type and attach it to the reason code where the reason type is set to Success.

  Note: You must attach the automatic payment success algorithm to an upload reason which you want to use while freezing automatic payments.

• Create an automatic payment cancel algorithm using the C1-APAY-CAN algorithm type and attach it to the reason code where the reason type is set to Cancel.

  Note: You must attach the automatic payment cancel algorithm to an upload reason which you want to use while canceling automatic payments.

• Create a void automatic refund algorithm using the C1-AREF-VOID algorithm type and attach it to the reason code where the reason type is set to Cancel.

  Note: You must attach the void automatic refund algorithm to an upload reason which you want to use while voiding automatic refunds.

• Create a characteristic type where the characteristic entity is set to Payment Tender. And, then specify this characteristic type as the value for the Tender Characteristic Type parameter in an algorithm which is created using the C1-APAY-SUCC algorithm type.

• Assign the C1-ACH To Do type to a To Do role whose users must receive the To Do entries generated when automatic payments are frozen with a Notice to Change (NOC).

• Assign the APAYUPTD To Do type to a To Do role whose users must receive the To Do entries generated when exceptions have occurred while executing the Freeze or Cancel Automatic Payments (APAYRA) batch.

• Define values for the following parameters in an algorithm which is created using the C1-APAY algorithm type:

  • Line Separator

  • Field Separator

  • Reject Upload Reason

  • Success Upload Reason