Regular FuturePay Agreement Parameters

To create a Regular FuturePay agreement the following additional parameters are required in the submission to WorldPay. The names refer to the parameters to be submitted in a form for plain text Select. If an item is to be unset then it should be omitted or submitted with an empty value. If you are using Select Pro then please see the additional notes below.

Parameter Format Comments Limitations

futurePayType String: "regular"

startDate yyyy-mm-dd Date on which the first payment will be made If set - must be in the future and not today. Option 2: must be 2 or more weeks in the future.

startDelayUnit One digit: 1-day, 2-week, 3-month, 4-year Unit of the delay between when the agreement is created and when the first payment will be made. Can only be set if start date is not specified. Only the listed values are valid. Option 2: Start delay must be at least 2 weeks.

startDelayMult integer Delay unit multiplier. The actual delay is obtained by multiplying the startDelayUnit by startDelayMult. If set must be >= 1.

noOfPayments integer Number of payments which will be made under the agreement Positive integer. Set to 0 or leave unset for unlimited.

intervalUnit One Digit: 1-day, 2-week, 3-month, 4-year The unit of the interval between payments Must be set except when number of payments is 1, in which case it cannot be set. Only the listed values are valid. Options 1,2: minimum interval is 2 weeks.

intervalMult integer The interval unit multiplier. The actual interval between payments is intervalUnit multiplied by intervalMult. If set must be >=1

initialAmount decimal The amount of the initial payment - if not set first payment will be for the normal amount.

Option 0: Can be set or not as you want

Option 1: Can be set or not as you want

Option 2: Cannot be set

normalAmount decimal Amount of normal payments

Option 0: Must be set, cannot be zero

Option 1: Must be set, cannot be zero. You can adjust it via WAS at any time.

Option 2: Cannot be set. You must set it via WAS before every payment.

option One Digit: 0, 1 or 2 Agreement Option Must be one of the listed values

In addition to these parameters the following must be set as for a normal purchase submission:

Parameter Comments

instId

cartId Merchants reference for the agreement and immediate payment if present

cost Should be set to 0 unless there is also an immediate payment

currency Currency for amounts specified in the agreement and immediate payment if present

desc Description for the agreement and immediate payment if present

Parameter	Comments
instId
cartId	Merchants reference for the agreement and immediate payment if present
cost	Should be set to 0 unless there is also an immediate payment
currency	Currency for amounts specified in the agreement and immediate payment if present
desc	Description for the agreement and immediate payment if present

Select Pro

You need to create a FuturePay object representing your agreement and attach it to the purchase token using the method "setFuturePay". The description and cart ID set on the purchase token are assigned to the agreement. The purchase token may also contain an immediate transaction.

Constructing a FuturePay Object

There is only one constructor for a Regular FuturePay Agreement. The constructor will throw an ArgumentException if the parameters passed to it are invalid.

public RegularFuturePay
         (Date startDate, TimePeriod startDelay, 
          int noOfPayments, TimePeriod interval, 
          CurrencyAmount initialAmount, CurrencyAmount normalAmount, 
          short option) throws ArgumentException

there is no futurePayType parameter as this is implied by the particular FuturePay class chosen.
startDelay and interval are represented by TimePeriod objects rather than a separate unit and multiplier.
amounts are represented by CurrencyAmount objects rather than a separate amount and currency parameter.
noOfPayments should be set to the constant PAYMENTS_unlimited (defined in this class) if you want no limit
if a parameter is to be unset then the value null should be used.
option should be one of the constants OPTION_0, OPTION_1 or OPTION_2, as defined in this class.

FuturePay Home Page