TransactionRequestObject

Used to run a new transaction.

Description

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

Properties

Type

Name

Description

string

Command

Processing command. Possible values: Sale, Credit, Void, CreditVoid, AuthOnly, Capture, PostAuth, Check, and CheckCredit. Default is Sale. (required)

boolean

IgnoreDuplicate

Do not check for duplicate transaction. Set to True if you would like to override the duplicate transaction handling. (required)

string

AuthCode

Original authorization code. Authorization code obtained offline (i.e., telephone authorization). Only required for PostAuth. (required)

string

RefNum

Original 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)

string

AccountHolder

Name of the account holder. (required)

TransactionDetail

Details

Transaction details: amount, clerk, currency, etc. (optional)

CreditCardData

CreditCardData

CreditCardData. Required for credit card transactions.

CheckData

CheckData

CheckData. Required for electronic check processing.

string

ClientIP

string

IP Address of client.

CustomerID. (required)

Address

BillingAddress

BillingAddress. (required)

Address

ShippingAddress

ShippingAddress. (optional)

boolean

CustReceipt

Customer Receipt. Set to “true” if you would like the gateway to send an email to customer's billing address email. (required)

string

Software

Software 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.

string

CustReceiptName

Name of the receipt template to use. Defaults to the standard customer receipt. (optional)

GwRecurringBilling

RecurringBilling

RecurringBilling. Object describing if recurring billing cycle should be created if initial transaction is approved. (optional)

LineItem

LineItems

Array of line item details. (optional)

FieldValue

CustomFields

Array of Custom Fields. (optional)

string

IfAuthExpired

Sets 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)