Request Fields
| Field Name | Mandatory? | Description |
|---|---|---|
| rtName | No | Free format short name for the agreement. |
| rtDescription | No | Free format longer description for the agreement. |
| rtPolicyRef | No | Merchant Policy Reference Number (MPRN). |
| rtAgreementType | No | Indicates the type of Continuous Authority or Repeat Billing agreement made with the Cardholder. One of: recurring (default) or instalment. |
| rtAmountFixed | No | Indicate if payment amounts will be fixed. One of: N (default) or Y |
| rtMerchantID | No | Merchant Account ID to use for the recurring transactions (defaults to merchantID). |
| rtStartDate | No | Start date of agreement (defaults to date received). |
| rtScheduleType | No | The type of payment schedule required. One of: fixed (default) or variable |
| rtSchedule | Yes[1] | Nested array or serialised string containing payment schedule information. |
| rtInitialDate | No[2] | Date of initial payment (defaults to rtStartDate). |
| rtInitialAmount | No[2] | Amount of initial payment (defaults to rtCycleAmount). |
| rtFinalDate | No[2] | Date of final payment. |
| rtFinalAmount | No[2] | Amount of final payment (defaults to rtCycleAmount). |
| rtCycleAmount | No[2] | Amount per cycle (defaults to amount). |
| rtCycleDuration | Yes[2] | Length of each cycle in rtCycleDurationUnit units. |
| rtCycleDurationUnit | Yes[2] | Cycle duration unit. One of: day, week, month or year. |
| rtCycleCount | Yes[2] | Number of cycles to repeat (zero to repeat forever). |
| rtMerchantData | No | Free format Merchant data field. |
| rtCloneFields | No | Fields to clone from one recurring transaction to the next. Refer to the Transaction Cloning section for details. |