Skip to main content

Request Fields

Field NameMandatory?Description
merchantIDYesYour Gateway Merchant Account ID.
merchantPwdNo[1]

Any password used to secure this account.

Refer to the Password Authentication section for details.

signatureYes[2]

Any hash used to sign this request.

Refer to the Message Signing section for details.

actionYes

The action requested.

Refer to the Supported Actions section for details.

Possible values are: CAPTURE, CANCEL, QUERY.

xrefYes

Reference to a previous transaction.

Refer to the Payment Tokenisation section for details.

amountNo[3]The amount to capture or refund.
callbackURLNo

A non-public URL which will receive a copy of the transaction result by POST.

The URL must be fully qualified and include at least the scheme and host components.

Refer to the Callback URL section for details.

Footnotes

  1. A password is not recommended if using the Hosted Integration, use a signature instead.
  2. A signature may be mandatory on some Merchant Accounts and requests.
  3. An amount is only required for partial refunds or partial captures.