TransactionRequestObject

Description

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

Properties

TypeNameDescription
stringCustReceiptNameReceipt template to use for the customer email. Defaults to the standard customer receipt template.
GwRecurringBillingRecurringBillingConfiguration for creating a recurring billing cycle if the initial transaction is approved.
LineItem[]LineItemsList of line item details associated with the transaction.
booleanIsRecurringWhether the transaction is a recurring payment.
stringInventoryLocationThe inventory location associated with the line items.
booleanIgnoreDuplicateWhether to override duplicate transaction handling, not checking for or blocking duplicate transactions.
stringIfAuthExpiredSets 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
TransactionDetailDetailsTransaction details such as amount, tax, and subtotal.
stringSoftwareSoftware application name/version.
booleanCustReceiptWhether to email a receipt to the customer's billing address email.
FieldValue[]CustomFieldsList of custom fields.
stringCustomerIDIdentifies the Customer associated with the transaction.
CreditCardDataCreditCardDataCredit card payment details for the transaction.
stringCommandThe type of transaction.
Possible Values
  • AuthOnly
  • Sale
  • Credit
  • QuickCredit
  • Check
  • Void
  • CreditVoid
  • QuickAuthOnly
  • PostAuth
  • Capture
  • Refund
  • PostAuth
stringClientIPThe client's IP address.
CheckDataCheckDataACH/eCheck payment details for the transaction.
GwAddressBillingAddressBilling address for the transaction.
stringAuthCodeAn offline authorization code from the customer's bank (i.e., telephone authorization).
stringAccountHolderName of the account holder for the payment method.
stringRefNumOriginal transaction reference number received when a transaction was authorized.
GwAddressShippingAddressShipping address for the transaction.