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
string TransKey Transaction Reference Number This is the preferred Transaction Identifier (ALWAYS System Scoped)
string RefNum Transaction Reference Number (sometimes Merchant Scoped)
string BatchRefNum Batch Reference Number assigned by Gateway.
string BatchKey Batch Reference Number assigned by Gateway.
string 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
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
CreditCardToken CreditCardToken This object describes a tokenized credit card.
integer ErrorCode Error Code (if transaction resulted in error)
string CustNum System assigned CustNum of stored customer record if one was used or created
string CustKey Customer Number (System assigned)
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
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

Examples

.NET VB

    newtek.TransactionResponse response = new newtek.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));
        }

.NET C

    newtek.TransactionResponse response = new newtek.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:string">445979</BatchRefNum>
        <BatchNum xsi:type="xsd:string">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:string">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:string">1175354</RefNum>
    <RefNum xsi:type="xsd:sting">1nfmkr4rsmtxhm5</TransKey>
        <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 Log

Version Change
1.7 Added TransKey, CustKey, and Batch Key. Changed BatchNum to type string, BatchRefNum to type string, CustNum to type string.
1.5 Added ProfilerScore, ProfilerResponse and ProfilerReason parameters
1.4 Added AuthAmount and RemainingBalance parameters
1.2 Added BatchRefNum parameter
1.1 Soap 1.1 Release (no changes)
1.0 Added Status and Status Code property