developer:soap-1.2:objects:transactionresponse

Soap API v1.2

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
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
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 transaction status
string StatusCode Single character code for transaction status

Places Used

Examples

.NET VB

Dim response As usaepay.TransactionResponse
 
response = client.runTransaction(token, tran)
 
MsgBox("Reference Number: " & response.RefNum)

.NET 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));
    }
}

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>

Change History

Version Change
1.2 Added BatchRefNum parameter
1.1 Soap 1.1 Release (no changes)
1.0 Added Status and Status Code property
developer/soap-1.2/objects/transactionresponse.txt · Last modified: 2010/10/20 15:18 by irina

Page Tools