Differences

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

@@ Line 1: / Line 1: @@
+<embed ..:contents/>
+====== TransactionResponse ======
+Contains details on the result of a processed transaction.
+===== Description =====
+This object contains the results which are displayed upon successful completion of a given transaction. Includes transaction result (approved, declined, error) and authorization codes and details.
+===== Properties =====
+^Type     ^Name     ^Description     ^
+|integer |RefNum |Transaction Reference Number|
+|integer |BatchRefNum |Batch Reference Number assigned by Gateway. |
+|integer |BatchNum |Batch Sequence Number|
+|string |Result |Transaction Result (Approved, Declined, Error, etc)|
+|string |ResultCode |Single character result code (A, D, or E)|
+|string |AuthCode |Authorization Code|
+|double |AuthAmount |Amount that was authorized.  Could be less that Amount requested if AllowPartialAuth was true (see [[developer:partialauth|Partial Authorizations]])|
+|double |RemainingBalance |Returns the balance remaining on some prepaid and stored value cards |
+|string |AvsResultCode |AVS Result Code (1-3 characters)|
+|string |AvsResult |Text Description of AvsResultCode|
+|string |CardCodeResultCode |Card Code (CVV2) Verification Result Code (1 character)|
+|string |CardCodeResult |Text Description of Card Code Result|
+|string |CardLevelResultCode | |
+|string |CardLevelResult |Text Description of Card Level Result|
+|integer |ErrorCode |Error Code (if transaction resulted in error)|
+|integer |CustNum |System assigned CustNum of stored customer record if one was used or created|
+|string |Error |Text Description of Error Code|
+|string |AcsUrl |ACS Url for Verified by Visa or Mastercard Secure Code.|
+|string |Payload |Payload for Verified by Visa or Mastercard Secure Code.|
+|string |VpasResultCode |Vpas Result Code.|
+|boolean |isDuplicate |If true, a duplicate transaction was detected and the response data returned is from original transaction.|
+|double |ConvertedAmount |Transaction amount converted to new currency.|
+|string |ConvertedAmountCurrency |Currency code for new currency.|
+|double |ConversionRate |Rate used to convert transaction amount.|
+|string |Status | Description of [[developer:statuscodes|transaction status]] |
+|string |StatusCode | Single character code for [[developer:statuscodes|transaction status]] |
+|string |ProfilerScore |Score generated by fraud profiler. |
+|string |ProfilerResponse |Fraud profiler result:  pass, warn, review.  Based on score thresholds |
+|string |ProfilerReason |Comma separated list of reason codes that contributed to the score. |
+===== Places Used =====
+[[..:methods:runTransaction]]
+[[..:methods:runTransactionAPI]]
+[[..:methods:runSale]]
+[[..:methods:runQuickSale]]
+[[..:methods:runCredit]]
+[[..:methods:postAuth]]
+[[..:methods:captureTransaction]]
+[[..:methods:getTransactionStatus]]
+[[..:methods:runCustomerTransaction]]
+===== Examples =====
+==== .NET VB ====
+<code vb>
+usaepay.TransactionResponse response = new usaepay.TransactionResponse();
+try
+{
+    response = client.runTransaction(token, tran);
+    if (response.ResultCode == "A")
+    {
+        MessageBox.Show(string.Concat("Transaction Approved, RefNum: ",
+                response.RefNum));
+    }
+    else
+    {
+        MessageBox.Show(string.Concat("Transaction Failed: ",
+                response.Error));
+    }
+</code>
+==== .NET C# ====
+<code c>
+usaepay.TransactionResponse response = new usaepay.TransactionResponse();
+try
+{
+    response = client.runTransaction(token, tran);
+    if (response.ResultCode == "A")
+    {
+        MessageBox.Show(string.Concat("Transaction Approved, RefNum: ",
+                response.RefNum));
+    }
+    else
+    {
+        MessageBox.Show(string.Concat("Transaction Failed: ",
+                response.Error));
+    }
+}
+</code>
+==== XML ====
+<code xml>
+<Response xsi:type="ns1:TransactionResponse">
+	<AcsUrl xsi:nil="true"/>
+	<AuthCode xsi:type="xsd:string">021730</AuthCode>
+	<AvsResult xsi:type="xsd:string">Address: Match &amp; 5 Digit Zip: Match</AvsResult>
+	<AvsResultCode xsi:type="xsd:string">YYY</AvsResultCode>
+	<BatchRefNum xsi:type="xsd:integer">445979</BatchRefNum>
+	<BatchNum xsi:type="xsd:integer">979</BatchNum>
+	<CardCodeResult xsi:type="xsd:string">Not Processed</CardCodeResult>
+	<CardCodeResultCode xsi:type="xsd:string">P</CardCodeResultCode>
+	<ConversionRate xsi:type="xsd:double">0</ConversionRate>
+	<ConvertedAmount xsi:type="xsd:double">0</ConvertedAmount>
+	<ConvertedAmountCurrency xsi:type="xsd:string">0</ConvertedAmountCurrency>
+	<CustNum xsi:type="xsd:integer">0</CustNum>
+	<Error xsi:type="xsd:string">Approved</Error>
+	<ErrorCode xsi:type="xsd:integer">0</ErrorCode>
+	<isDuplicate xsi:type="xsd:boolean">false</isDuplicate>
+	<Payload xsi:nil="true"/>
+	<RefNum xsi:type="xsd:integer">1175354</RefNum>
+	<Result xsi:type="xsd:string">Approved</Result>
+	<ResultCode xsi:type="xsd:string">A</ResultCode>
+	<Status xsi:type="xsd:string">Pending</Status>
+	<StatusCode xsi:type="xsd:string">P</StatusCode>
+	<VpasResultCode xsi:nil="true"/>
+</Response>
+</code>
+===== Change History =====
+^Version ^Change ^
+|[[developer:soap-1.5:objects:transactionresponse|1.5]] |Added ProfilerScore, ProfilerResponse and ProfilerReason parameters |
+|[[developer:soap-1.4:objects:transactionresponse|1.4]] |Added AuthAmount and RemainingBalance parameters |
+|[[developer:soap-1.2:objects:transactionresponse|1.2]] |Added BatchRefNum parameter |
+|[[developer:soap-1.1:objects:transactionresponse|1.1]] | Soap 1.1 Release (no changes) |
+|[[developer:soap-1.0:objects:transactionresponse|1.0]] | Added Status and Status Code property |