TransactionRequestObject

Description

The TransactionRequestObject object contains the data used to create a new transaction.

Properties

Type

Name

Description

string

CustReceiptName

Receipt template to use for the customer email. Defaults to the standard customer receipt template.

GwRecurringBilling

RecurringBilling

Configuration for creating a recurring billing cycle if the initial transaction is approved.

LineItem[]

LineItems

List of line item details associated with the transaction.

boolean

IsRecurring

Whether the transaction is a recurring payment.

string

InventoryLocation

The inventory location associated with the line items.

boolean

IgnoreDuplicate

Whether to override duplicate transaction handling, not checking for or blocking duplicate transactions.

string

IfAuthExpired

Sets the behavior when a Capture command is attempted on an expired authorization. Defaults to capturing even if the authorization is expired.

Possible Values
  • error - block capture and return an error
  • reauth - request reauthorization before capturing

TransactionDetail

Details

Transaction details such as amount, tax, and subtotal.

string

Software

Software application name/version.

boolean

CustReceipt

Whether to email a receipt to the customer's billing address email.

FieldValue[]

CustomFields

List of custom fields.

string

CustomerID

Identifies the Customer associated with the transaction.

CreditCardData

CreditCardData

Credit card payment details for the transaction.

string

Command

The type of transaction.

Possible Values
  • AuthOnly
  • Sale
  • Credit
  • QuickCredit
  • Check
  • Void
  • CreditVoid
  • QuickAuthOnly
  • PostAuth
  • Capture
  • Refund
  • PostAuth

string

ClientIP

The client's IP address.

CheckData

CheckData

ACH/eCheck payment details for the transaction.

GwAddress

BillingAddress

Billing address for the transaction.

string

AuthCode

An offline authorization code from the customer's bank (i.e., telephone authorization).

string

AccountHolder

Name of the account holder for the payment method.

string

RefNum

Original transaction reference number received when a transaction was authorized.

GwAddress

ShippingAddress

Shipping address for the transaction.