developer:soap-1.6:objects:transactionobject

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:objects:transactionobject [2012/08/04 11:45] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​
 +
 +
 +====== TransactionObject ======
 +
 +Contains all transaction data.
 +
 +===== Description =====
 +
 +This object contains all of the data on a transaction. Some fields are masked for security reasons and some fields are specific to credit card or electronic check transactions.
 +
 +Some information stored in this object is important for security reasons such as the username of the person who processed the transaction,​ the IP address of the server from which it was submitted and the source key that the transaction was processed under.
 +
 +
 +
 +===== Properties =====
 +
 +^Type    ^Name    ^Description ​   ^
 +|string |Status |Status of specified transaction.|
 +|[[TransactionResponse]] | Response |Gateway response details, includes AuthCode etc.  |
 +|string |TransactionType |Type of transaction. (Sale, Credit, Void, AuthOnly, etc.)|
 +|[[CheckTrace]] |CheckTrace |Tracking data for check transactions. Includes tracking number, effective posting date, date processed, date settled, date returned and bank notes.|
 +|string |DateTime |Date/time transaction was originally submitted.|
 +|string |AccountHolder |Name of the account holder.|
 +|[[TransactionDetail]] |Details |Transaction details. (amount, invoice number, clerk, description,​ currency, etc.)|
 +|[[CreditCardData]] |CreditCardData |Credit card specific data. (card type, number, expiration date, etc.)|
 +|[[CheckData]] |CheckData |Check specific data. (checking account and routing number, etc.)|
 +|string |User |The username of the person who processed this transaction.|
 +|string |Source |The name of the source key that this transaction was processed under.|
 +|string |ServerIP |IP Address of the server that submitted the transaction to the gateway.|
 +|string |ClientIP |IP Address of client (if passed on from the server).|
 +|string |CustomerID |Customer ID|
 +|[[Address]] |BillingAddress |Billing Address|
 +|[[Address]] |ShippingAddress |Shipping Address|
 +|[[FieldValue]] |CustomFields |Array of custom transaction fields |
 +|[[LineItem]] |LineItems | |
 +
 +
 +===== Places Used =====
 +
 +[[..:​methods:​getTransaction]]
 +
 +[[..:​methods:​getBatchTransactions]]
 +
 +===== Examples =====
 +==== .NET VB ====
 +<code vb>
 +Dim response As usaepay.TransactionObject
 + 
 +        response = client.getTransaction(token,​ refnum)
 + 
 +        MsgBox("​Transaction Type: " & response.TransactionType)
 +</​code>​
 +
 +==== .NET C# ====
 +<code c>
 +usaepay.TransactionObject tran = new usaepay.TransactionObject();​
 + 
 +            try
 +            {
 +                tran = client.getTransaction(token,​ refnum);
 +                MessageBox.Show(string.Concat("​Transaction RefNum: ",
 +                            tran.Response.RefNum));​
 + 
 + 
 +            }
 +
 +</​code>​
 +
 +===== Change History =====
 +
 +^Version ^Change ^
 +|[[developer:​soap-1.2:​objects:​transactionobject|1.2]] |Added CustomFields property. |
 +|[[developer:​soap-1.1:​objects:​transactionobject|1.1]] | Soap 1.1 Release (no changes) |
 +|[[developer:​soap-1.0:​objects:​transactionobject|1.0]] | Response property added |
  
developer/soap-1.6/objects/transactionobject.txt ยท Last modified: 2012/08/04 11:45 by tem

Page Tools