Soap API v1.2


Contains transaction specific data for customer database transactions run via runCustomerTransaction() method.


This object is used with the runCustomerTransaction() method 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 11 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.
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 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.
double Amount Total billing amount. (Subtotal+Tax+Tip+Shipping-Discount=Amount.)
integer Currency Currency Code. 3 digit currency code of total amount.
double Tax Portion of total amount that is tax.
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.
double Discount Amount of discount.
double Subtotal The amount of the transaction before tax, tip, shipping and discount have been applied.
boolean isRecurring Flag transaction as recurring.
string CVV Card ID Value (CVV2, CVC, etc)

Places Used



Dim tran As usaepay.CustomerTransactionDetail = New usaepay.CustomerTransactionDetail
        tran.Invoice = "123456"
        tran.Description = "Sample Credit Card Sale"
        tran.Amount = 1.05
        tran.AmountSpecified = True


usaepay.CustomerTransactionDetail tran = new usaepay.CustomerTransactionDetail();
            tran.Invoice = "123456";
            tran.Description = "Sample Credit Card Sale";
            tran.Amount = 1.05;
            tran.AmountSpecified = true;

Change Log

Version Change
1.2 New object added in 1.2 release
developer/soap-1.2/objects/customertransactiondetail.txt · Last modified: 2010/10/20 15:05 by irina

Page Tools