Soap API v1.6


Contains transaction specific data.


This object is used with several transaction methods and contains important transaction specific data such as invoice number, originating terminal, total amount of transaction, portions of total alloted for tip, tax and shipping, and currency code.


Type Name Description
string Invoice Transaction invoice number. Will be truncated to 10 characters. If this field is not provided, the system will submit the RefNum in its place.
string PONum Purchase Order Number for commercial card transactions - 25 characters. (Required for Level 2 & 3)
string OrderID Transaction order ID. This field should be used to assign a unique order id to the transaction. The order ID can support 64 characters.
string SessionID Optional Session ID used for customer analytics and fraud prevention. Must be get generated using the getSession method. See the profiling guide for more information
string Clerk Sales Clerk. Optional value indicating the clerk/person processing transaction, for reporting purposes.
string Terminal Terminal Name. Optional value indicating the terminal used to process transaction, for reporting purposes.
string Table Restaurant Table Number. Optional value indicating the restaurant table, for reporting purposes
string Description Transaction description.
string Comments Comments. Free form text.
boolean AllowPartialAuth Allow a partial authorization if full amount is not available (Defaults to false)
double Amount Total billing amount. (Subtotal+Tax+Tip+Shipping-Discount=Amount.)
string Currency Currency Code. 3 digit currency code of total amount.
double Tax Portion of total amount that is tax. (Required for Level 2 & 3)
double Tip Portion of total amount that is tip.
boolean NonTax Determines whether a transaction is non-taxable.
double Shipping Portion of total amount that is shipping charges. (Required for Level 3)
double ShipFromZip Zipcode that the order is shipping from. (Required for Level 3)
double Discount Amount of discount.
double DutyAmount of duty charged. (Required for Level 3)
double Subtotal The amount of the transaction before tax, tip, shipping and discount have been applied.

Places Used



Dim details As usaepay.TransactionDetail = New usaepay.TransactionDetail
        details.Amount = "34.50"
        details.AmountSpecified = True
        details.Description = "Example QuickSale"
        details.Invoice = "123456"


usaepay.TransactionDetail details = new usaepay.TransactionDetail();
            details.Amount = 34.50;
            details.AmountSpecified = true;
            details.Description = "Example QuickSale";
            details.Invoice = "123456";

Change Log

Version Change
1.6 Added parameters Duty, ShipFromZip.
1.5 Added SessionID parameter
1.4 Changed Currency parameter from integer to string, Add AllowPartialAuth parameter
developer/soap-1.6/objects/transactiondetail.txt · Last modified: 2012/11/19 10:16 by tem

Page Tools