Action string For this operation, one of the following values MUST be used:
  • payment
  • preauth
  • verify_only
TestMode boolean

Flag to indicate whether transactions should be processed in test mode. (see section Test Mode Transactions)

If present must be either "true" or "false". If absent, defaults to "false" resulting in transactions being submitted for authorisation.

Amount 64 bit integer

Transaction amount in the lowest denomination for the currency.

If AUD use 12000 for $120.00. If JPY use 120 for ¥120

AmountOriginal 64 bit integer Total payment amount without surcharge - this field is for information and reporting only and does not alter the value of the transaction. (as specified by Amount)
AmountSurcharge 64 bit integer Surcharge amount for payment - this field is for information and reporting only and does not alter the value of the transaction. (as specified by Amount)
{{platform.PaymentReason}} string {{platform.PaymentSpaceReason}} for the transaction.
{{platform.Reference}}1 string This field should be unique for each transaction.
{{platform.Reference}}2 string
{{platform.Reference}}3 string
Currency string

The currency that the transaction is to be processed in as an ISO 4217 code (see section Currency List)

Your bank merchant account must be configured to accept the currency used in this field.

Please speak to your bank if you are unsure what currencies your bank merchant account can transact in .

Customer JSON object containing customer details.
TokenisationMode 64 bit integer Determines whether or not tokenisation of the payment instrument will occur:

    China UnionPay cards cannot be tokenised. When a China UnionPay card is used for a payment, a token will not be returned in the transaction result or webhook.

    {{platform.InternalNote}} string {{platform.InternalSpaceNote}}
    Order JSON object containing order details.
    SubType string Defines a sub type for transaction:
      Type string Defines a type for transaction:
        {{platform.Token}}Data

        JSON object used for token payments.

        FraudScreeningRequest

        JSON object used for Fraud Screening.

        If this object is null, no fraud screening will be performed.

        EmailAddress string Customer's email address.
        AmexExpressCheckout boolean Determines whether or not the Amex Express Checkout displays as a payment option:
          (see Amex Express Checkout section to complete configurations)
          Bypass{{platform._3}}DS boolean If set to true this will force the transaction to bypass {{platform._3}}DS
          StatementDescriptor

          Contact information to be printed on the cardholders' account statements. Statement Descriptors are for Payment Facilitators only. The Statement Descriptors will only be used if you have this feature. Please contact the bank if you are a Payment Facilitator and wish to use this feature. Note, the cardholders' bank may not display all the information on the cardholders' statement.