Used to run a new transaction.


This object contains the data needed to run a new transaction, including sale, credit, void, and auth-only.


stringCommandProcessing command. Possible values: Sale, Credit, Void, CreditVoid, AuthOnly, Capture, PostAuth, Check, and CheckCredit. Default is Sale. (required)
booleanIgnoreDuplicateDo not check for duplicate transaction. Set to True if you would like to override the duplicate transaction handling. (required)
stringAuthCodeOriginal authorization code. Authorization code obtained offline (i.e., telephone authorization). Only required for PostAuth. (required)
stringRefNumOriginal transaction reference number. The RefNum received when a transaction was authorized via either the Sale or AuthOnly commands. Required for Void and Capture commands only. (required)
stringAccountHolderName of the account holder. (required)
TransactionDetailDetailsTransaction details: amount, clerk, currency, etc. (optional)
CreditCardDataCreditCardDataCreditCardData. Required for credit card transactions.
CheckDataCheckDataCheckData. Required for electronic check processing.
stringIP Address of client.CustomerID. (required)
AddressBillingAddressBillingAddress. (required)
AddressShippingAddressShippingAddress. (optional)
booleanCustReceiptCustomer Receipt. Set to “true” if you would like the gateway to send an email to customer's billing address email. (required)
stringSoftwareSoftware Name/version. Allows application developers to stamp their application name and version number onto each transaction. Used to assist customers with trouble shooting. Not Required.
stringCustReceiptNameName of the receipt template to use. Defaults to the standard customer receipt. (optional)
GwRecurringBillingRecurringBillingRecurringBilling. Object describing if recurring billing cycle should be created if initial transaction is approved. (optional)
LineItemLineItemsArray of line item details. (optional)
FieldValueCustomFieldsArray of Custom Fields. (optional)
stringIfAuthExpiredSets what will happen when a “capture” command is sent on authorization that has expired. By default the expiration will be ignored and the authorization will be captured. If set to “error” the capture will be blocked and an error will be returned. If set to “reauth” the system will send in a new authorization request to the platform before capturing the transaction. (required)