Skip to main content

Request Fields

Field NameMandatory?Description
xrefYesReference to initial CIT or previous MIT transaction.
typeYes[1]

The type of transaction.

Possible values are:

1 – E-commerce (ECOM) (CIT).

2 – Mail Order/Telephone Order (MOTO), (CIT) or Card Not Present (CNP)(MIT).

9 – Continuous Authority (CA) (MIT).

rtAgreementTypeYes[2]

Consumer/Merchant agreement type.

Possible values are:

cardonfile – credential storage agreed (CIT/MIT).

recurring – recurring type agreed (CIT/MIT).

instalment – instalment type agreed (CIT/MIT).

unscheduled – ad hoc COF payment (MIT).

incremental[3] – authorisation amount increment (MIT).

resubmission – failed authorisation retry (MIT).

reauthorisation – expired authorisation refresh (MIT).

delayedcharges – post authorisation charges (MIT).

noshow – missed reservation penalty (MIT).

rtSequenceCountNo[4]Number of transactions in a recurring sequence if known.
rtSequenceNumberNo[4]Transaction number in a recurring sequence if known.
rtAmountFixedNo

Indicate if payment amounts will be fixed or variable.

Possible values are:

N – amounts will be variable (default).

Y – amounts will be fixed.

initiatorNo[5]

Indicate who initiated the transaction.

Possible values are:

consumer – consumer initiated (CIT)

merchant – merchant initiated (MIT)

For backwards compatibility, the Gateway will try to automatically identify if a transaction is CIT or MIT from the values provided for the action, type and rtAgreementType fields. You may also pass the initiator field in the request to force a classification. If, however, the requested classification is incompatible with the provided request fields then the transaction will fail with a responseCode of 66944 (INVALID INITIATOR). The initiator field will be returned in the response with either the value passed in the request or the automatically identified value.

Footnotes

  1. Required differentiate between initial and subsequent recurring or instalment transaction
  2. Mandatory for some Acquirers, its use is highly recommended with recurring transactions.
  3. MIT type incremental is not currently supported but reserved for future use.
  4. Mandatory for some Acquirers, its use is highly recommended with recurring transactions.
  5. If not provided the Gateway will attempt to determine the initiator from the other request values.