Skip to main content

Request Fields

Field NameMandatory?Description
rtNameNoFree format short name for the agreement.
rtDescriptionNoFree format longer description for the agreement.
rtPolicyRefNoMerchant Policy Reference Number (MPRN).
rtAgreementTypeNo

Indicates the type of Continuous Authority or Repeat Billing agreement made with the Cardholder.

One of: recurring (default) or instalment.

rtAmountFixedNo

Indicate if payment amounts will be fixed.

One of: N (default) or Y

rtMerchantIDNoMerchant Account ID to use for the recurring transactions (defaults to merchantID).
rtStartDateNoStart date of agreement (defaults to date received).
rtScheduleTypeNo

The type of payment schedule required.

One of: fixed (default) or variable

rtScheduleYes[1]Nested array or serialised string containing payment schedule information.
rtInitialDateNo[2]Date of initial payment (defaults to rtStartDate).
rtInitialAmountNo[2]Amount of initial payment (defaults to rtCycleAmount).
rtFinalDateNo[2]Date of final payment.
rtFinalAmountNo[2]Amount of final payment (defaults to rtCycleAmount).
rtCycleAmountNo[2]Amount per cycle (defaults to amount).
rtCycleDurationYes[2]Length of each cycle in rtCycleDurationUnit units.
rtCycleDurationUnitYes[2]

Cycle duration unit.

One of: day, week, month or year.

rtCycleCountYes[2]Number of cycles to repeat (zero to repeat forever).
rtMerchantDataNoFree format Merchant data field.
rtCloneFieldsNoFields to clone from one recurring transaction to the next. Refer to the Transaction Cloning section for details.

Footnotes

  1. For use with variable schedules only.
  2. For use with fixed schedules only.