Scheduling
There are two different types of scheduling available when requesting the Gateway to take recurring transactions automatically on the Merchant’s behalf. In addition, a start date can be provided to allow for a recurring subscription with an initial free trial period.
Fixed Scheduling
Fixed scheduling causes the subsequent transaction to be taken at fixed intervals of time and for fixed amounts. A different initial date and amount or final date and amount can be provided for use when the agreed payment term or amount doesn’t exactly divide by the fixed time intervals.
Fixed scheduling is specified by providing an rtScheduleType field with a value of ‘fixed’ and providing the rtCycleDuration, rtCycleAmount and rtCycleCount fields to define the interval at which transactions should be taken and the number of transactions to take.
An rtCycleCount field value of 0 can be provided to indicate that transactions should be taken ad-infinitum until the RTA is stopped.
Variable Scheduling
Variable scheduling causes the subsequent transaction to be taken on prespecified dates and for prespecified amounts.
Variable scheduling is specified by providing an rtScheduleType field with a value of ‘variable’ and providing the rtSchedule field with a value containing an array of one or more schedule records.
Each schedule record must contain the following fields:
| Field Name | Mandatory? | Description |
|---|---|---|
| date | Yes | Date on which to take a payment. |
| amount | Yes | Amount to take on the provided date. |
The schedule records should be passed in a sequential array of records, either as nested records or serialised records. The record field names are case sensitive.