Variable Payment Schedule
Below shows the fields that appear when you want to create an RT Agreement for a variable schedule:
RT Agreement Lookup
RT Agreement: This allows you to search for a specific Agreement by ID or Agreement Name.
RT Agreement Creator
Rule Name (Required): This gives you the option to give the new RT Agreement a specific name. The default is an automatically generated and can be changed.
Description (Optional): The description field can be used for further information (e.g. logging who created the Agreement, etc).
Policy Reference (Required): This gives you the option to assign a unique policy reference, this is the Policy Reference Number (MPRN) used by the customer to refer to this agreement with the relevant card schemes etc., if not provided a reference will be automatically generated.
Initial Transaction Details
Initial Transaction (Required): This is the cross reference of the transaction that acts as the basis for each recurring transaction. This transaction is used to provide the payment information (card number, expiry date, etc.), payment currency and as the default for any unique transaction reference and cycle amounts.
Subsequent Transaction Details
Merchant Account (Required): Specify the Merchant Account you wish to set the RT Agreement up on. The Merchant account must support the base transaction’s currency and card type.
Start Date (Required): Specify the date the RT Agreement should start, unless an 'initial payment date' is also specified, this will be the date from which the payment cycle starts. This defaults to 'Today'.
Unique Reference (Required): A 'Unique Reference' and 'Order Description' can be specified for each payment which overrides any used in the base transaction. The actual transaction sequence number will be automatically appended to the 'Unique Reference' to ensure it is unique. This defaults to base transaction's value.
Cloned Fields (Optional): Specify any additional Gateway parameters you wish to include in future transactions from the original (e.g. statementNarrative1).
Payment ScheduleSchedule Type: Specify the schedule type required - on this occasion you'll need 'Variable Payment Schedule'. Fixed Scheduling allows an amount and frequency to be specified alone with any optional initial and final payment. Variable scheduling allows the exact dates and amounts to be specified.
Variable Payment Schedule
Schedule (Required): Specify the dates and amounts of each recurring payment made under this agreement. The dates and amounts can be varied.
Max Retry Attempts: The system will attempt to retry failed payments once every 15 minutes until the specified maximum number of attempts have been made. If no retries are required then enter a zero, a blank entry will default to 4 attempts.
Once ‘Create Agreement’ has been clicked, the Agreement will be activated and put in place.