runCheckSale

Run a new check sale transaction.

Description

This method is equivalent to running the runTransaction method with the Command set to Check:Sale. Instead of charging a customer's credit card, this method uses the customer's bank information (bank routing number and customer account number) to electronically deduct the required funds from the customer's checking account.

It will run a transaction debit a customer's checking or savings account via ACH for the desired amount. If a mistake is made or a refund must be given you can use either the overrideTransaction, voidTransaction, refundTransaction or runCheckCredit method.

If the sale is for a customer whose information has been stored, you may use the runCustomerTransaction method to avoid having to reenter all of the customer's information.

Syntax

TransactionResponse runCheckSale ( ueSecurityToken Token, TransactionRequestObject Params )

Arguments

Type	Name	Description
ueSecurityToken	Token	Merchant security token: used to identify merchant and validate transaction.
TransactionRequestObject	Params	Transaction details from all fields of the transaction form, including reference number, transaction amount, customer ID, currency, authorization code, and any other information entered at the time of the transaction.

Return Value

TransactionResponse

Returns a TransactionResponse object containing the results of the transaction and all relevant data.

Examples

PHP

<?php

try {

$Request=array(

'AccountHolder' => 'Tester Jones',

'Details' => array(

'Description' => 'Example Transaction',

'Amount' => '4.99',

'Invoice' => '44539'

'CheckData' => array(

'CheckNumber' => '1234',

'Routing' => '123456789',

'Account' => '11111111',

'AccountType' => 'Savings',

'DriversLicense' => '34521343',

'DriversLicenseState' => 'CA',

'RecordType' => 'PPD'

)

);

$res=$client->runCheckSale($token, $Request);

}

catch (SoapFault $e) {

echo $client->__getLastRequest();

echo $client->__getLastResponse();

die("runCheckSale failed :" .$e->getMessage());

}

Java

try {

TransactionRequestObject params = new TransactionRequestObject();

//set account holder name

params.setAccountHolder("Test Joe");

// populate transaction details

TransactionDetail details = new TransactionDetail();

details.setAmount(22.34);

details.setDescription("My Test Sale");

details.setInvoice("119891");

params.setDetails(details);

// populate credit card data

CheckData checkdata = new CheckData();

checkdata.setRouting("123123123");

checkdata.setAccount("321321");

params.setCheckData(checkdata);

// Create response object

TransactionResponse response;

// run sale

response = client.runCheckSale(token, params);

System.out.println("Response: " + response.getResult() + " RefNum: " + response.getRefNum());

} catch (Exception e) {

System.out.println("Soap Exception: " + e.getMessage());

}

VB

Dim client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService

Dim token As eBizCharge.ueSecurityToken

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

Dim transaction As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject

transaction.CheckData = New eBizCharge.CheckData

transaction.CheckData.Account = "1112223333"

transaction.CheckData.Routing = "123456789"

transaction.CheckData.DriversLicense = "D5555555"

transaction.CheckData.DriversLicenseState = "CA"

transaction.Details = New eBizCharge.TransactionDetail

transaction.Details.Amount = "1.00"

transaction.Details.AmountSpecified = True

transaction.Details.Invoice = "55555"

transaction.Details.Description = "Test Check Sale"

transaction.AccountHolder = "Test Guy"

Dim response As eBizCharge.TransactionResponse = New eBizCharge.TransactionResponse

response = client.runCheckSale(token, transaction)

If response.ResultCode = "A" Then

MsgBox("Transaction Approved, Reference Number: " & response.RefNum)

ElseIf response.ResultCode = "D" Then

MsgBox("Transaction Declined, Reason: " & response.Error)

Else

MsgBox("Transaction Error, Reason: " & response.Error)

End If

.NET C#

eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();

tran.Details = new eBizCharge.TransactionDetail();

tran.Details.Amount = 1.00;

tran.Details.AmountSpecified = true;

tran.Details.Invoice = "1234";

tran.Details.Description = "Sample Check Sale";

tran.CheckData = new eBizCharge.CheckData();

tran.CheckData.Account = "1112223333";

tran.CheckData.Routing = "123456789";

tran.CheckData.DriversLicense = "D5555555";

tran.CheckData.DriversLicenseState = "CA";

tran.AccountHolder = "Test Guy";

eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();

try

{

response = client.runCheckSale(token, tran);

if (response.ResultCode == "A")

{

MessageBox.Show(string.Concat("Transaction Approved, RefNum: ",

response.RefNum));

}

else

{

MessageBox.Show(string.Concat("Transaction Failed: ",

response.Error));

}

catch (Exception err)

{

MessageBox.Show(err.Message);

}

XML

<?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:runCheckSale>

</PinHash>

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

</Token>

<AccountHolder xsi:type="xsd:string">Tester Jones 111</AccountHolder>

<AccountType xsi:type="xsd:string">Savings</AccountType>

</CheckData>

<Description xsi:type="xsd:string">Example Transaction</Description>

</Details>

</Params>

</ns1:runCheckSale>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>