If you integrated with the Hosted Payment Page all of the following additional parameters are required in a payment submission to us. The following examples demonstrate the effects of various combinations of parameters. If an item is to be unset then it should be omitted or submitted with an empty value.
For examples of these parameters please refer to Regular Agreement Parameter Examples.
|
Parameter |
Format |
Comments |
Limitations |
|
futurePayType |
String: "regular" |
|
|
|
startDate |
yyyy-mm-dd |
The date on which the first payment will be made. |
If this is set, the start date must be in the future and not today. If not set, the agreement is set-up and marked as awaiting-start-date. The start date can be set later using the Worldpay Business Manager. Option 2: must be two weeks or more in the future. |
|
startDelayUnit |
One digit: 1-day, 2-week, 3-month, 4-year. |
The unit of the delay between when the agreement is created and when the first payment will be made. |
This can only be set if the 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. Option 1: can be set or not. 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 using the iadmin servlet at any time. Option 2: cannot be automatically set. You must set it using the iadmin servlet before every payment. |
|
option |
One Digit: 0, 1 or 2. |
Agreement option. |
Must be one of the listed values. |
In addition to the above parameters, the parameters shown below must be set as for a normal purchase submission.
|
Parameters |
Comments |
|
instId |
Merchant's installation reference. |
|
cartId |
Merchant's reference for the agreement and immediate payment if present. The following special characters are not allowed for the cartId parameter: |
|
amount |
Should be set to 0 unless there is also an immediate payment. |
|
currency |
Currency for amounts defined in the agreement and immediate payment, if present. |
|
desc |
Description for the agreement and immediate payment, if present. The following special characters are not allowed for the desc parameter: |
|
|
|
