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.

Syntax

CheckTrace getCheckTrace ( ueSecurityToken Token, integer RefNum )

Arguments

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

Return Value

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

<?php

try {

$RefNum=1119999999;

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

print_r($res);

}

catch(SoapFault $e) {

echo $e->getMessage();

}

VB

Dim client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService

Dim token As eBizCharge.ueSecurityToken

token = Me.CreateToken("714SSUxv1uohng2XkMJ7kLpETsu58G66", "1234")

Dim refnum As Integer

refnum = 46999316

Dim trace As eBizCharge.CheckTrace = New eBizCharge.CheckTrace

trace = client.getCheckTrace(token, refnum)

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

.NET C#

string refnum;

refnum = "46973419";

eBizCharge.CheckTrace trace = new eBizCharge.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:eBizCharge" 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>

</PinHash>

<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>

</Token>

</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:eBizCharge"

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>

<Status xsi:type="xsd:string">Returned</Status>

<BankNote xsi:type="xsd:string">Example Note</BankNote>

<Reason xsi:type="xsd:string">Insufficent Funds</Reason>

</getCheckTraceReturn>

</ns1:getCheckTraceResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>