getCheckTrace

Retrieve the current status and tracking data for a specific electronic check transaction.

Description

This method allows you to check the status and tracking data on an electronic check transaction.

Use this method to determine what state a check transaction is in.

To specify the transaction you would like to view, you must retrieve it using the reference number (RefNum) assigned to the transaction by the gateway. The RefNum is assigned by the gateway and returned when a transaction is processed. To find a missing RefNum, use the searchTransactions method.

See also getTransaction, getTransactionStatus

Syntax

CheckTrace getCheckTrace ( :ueSecurityToken Token, string RefNum )

Arguments

Type	Name	Description
ueSecurityToken	Token	Merchant security token: used to identify merchant and validate transaction.
string	RefNum	Transaction Reference number assigned by the gateway.

Return Value

Type	Description
CheckTrace	Returns a CheckTrace object containing the check specific status and tracking information

Exceptions

The following exceptions (errors) are applicable to this method.

Code	Message	Advice
20001	Specified transactions was not found.	RefNum provided was not found by the system. Make sure the RefNum was not truncated and belongs to this merchant (identified by Token) on this server (Sandbox RefNum cannot be looked up in production and vice versa).
40201	Incorrect transaction type	getCheckTrace will only work for electronic check transactions. This exception will be thrown if RefNum refers to a credit card transaction

Examples

PHP

For directions on how to set up the WSDL link, create "$token" and "$client", go to PHP Soap How-to.

    <?php

    try {

      $RefNum=1119999999;

      $res = $client->getCheckTrace($token, $RefNum);
      print_r($res);
    }

    catch(SoapFault $e) {

      echo $e->getMessage();

    }

    ?>

VB

For directions on how to set up the WSDL link and create the "token" and "client" variables, go to the Visual Basic .Net Soap How-to.

    Dim client As newtek.newtekService = New newtek.newtekService
        Dim token As newtek.ueSecurityToken

        token = Me.CreateToken("714SSUxv1uohng2XkMJ7kLpETsu58G66", "1234")
        Dim refnum As Integer

        refnum = 46999316

        Dim trace As newtek.CheckTrace = New newtek.CheckTrace

        trace = client.getCheckTrace(token, refnum)

        MsgBox("Tracking Number: " & trace.TrackingNum)

.NET C

For directions on how to set up the WSDL link and create the "token" and "client" variables, go to the C Sharp .Net Soap How-to.

    string refnum;
                refnum = "46973419";

                newtek.CheckTrace trace = new newtek.CheckTrace();

                try
                {
                    trace = client.getCheckTrace(token,refnum);

                    MessageBox.Show(string.Concat(trace.TrackingNum));

                }


                catch (Exception err)
                {
                    MessageBox.Show(err.Message);
                }

XML

Request:

    <?xml version="1.0" encoding="UTF-8"?>
    <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="urn:newtek"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
    SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
    <ns1:getCheckTrace>
    <Token xsi:type="ns1:ueSecurityToken">
    <ClientIP xsi:type="xsd:string">123.123.123.123</ClientIP>
    <PinHash xsi:type="ns1:ueHash">
    <HashValue xsi:type="xsd:string">c194ee3e3c2ee652a8a197cd86a8a7ec5279f2fd</HashValue>
    <Seed xsi:type="xsd:string">1845463236-test</Seed>
    <Type xsi:type="xsd:string">sha1</Type>
    </PinHash>
    <SourceKey xsi:type="xsd:string">_B4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
    </Token>
    <RefNum xsi:type="xsd:string">102284362</RefNum>
    </ns1:getCheckTrace>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>

Response:

    <?xml version="1.0" encoding="utf-8"?><SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="urn:newtek"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
    SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
    <ns1:getCheckTraceResponse>
    <getCheckTraceReturn xsi:type="ns1:CheckTrace">
    <Status xsi:type="xsd:string">Pending</Status>
    <StatusCode xsi:type="xsd:string">P</StatusCode>
    <Effective xsi:type="xsd:string">2015-11-24</Effective>
    <TrackingNum xsi:type="xsd:string">15112348321864</TrackingNum>
    </getCheckTraceReturn>
    </ns1:getCheckTraceResponse>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>