developer:soap-1.4:objects:checkdata

Table of Contents

Soap API v1.4

CheckData

Contains information for electronic check transactions.

Description

This object is used for electronic check processing and includes all of the fields required for processing a check transaction.

Properties

Type Name Description
Integer CheckNumber Check number of check being used for transaction.
String Routing Nine digit bank routing number.
String Account Bank account number.
String AccountType Checking or Savings - if left blank, default is Checking.
String DriversLicense Driver's license of checking account holder.
String DriversLicenseState Driver's license state of issue.
String RecordType Record type of electronic check transaction. Not supported by all check processors. List of Check Record Types
String AuxOnUS MICR Data for Check 21 (optional)
String EpcCode MICR Data for Check 21 (optional)
String FrontImage Scan of front of check, base64 encoded (optional)
String BackImage Scan of back of check, base64 (optional)

Places Used

TransactionObject TransactionRequestObject

Examples

PHP

<?php 
// for directions on how to set up the  
// WSDL link and create "$token" and "$client," 
// see: http://wiki.usaepay.com/developer/soap/howto/php
 
$CheckData=array(
	'CheckNumber' => '321',
	'Account' => '123456',
	'Routing' => '123456789',
	'AccountType' => 'Savings',
	'DriversLicense' => '123123123',
	'DriversLicenseState' => 'NA',
	'RecordType' => 'ARC'
);		
 
$Request=array(
  'AccountHolder' => 'Example Creator',
  'ClientIP' => '123.123.123.123',
  'CustomerID' => '123456',
  'Command' => 'Check',
  'Details' => array(
        'Amount' => '29.00',
	'Clerk' => 'John Doe',
	'Currency' => '0',
	'Description' => 'Example for CheckData object',
	'Discount' => '1.00',
	'Invoice' => '44539'),
  'CheckData' => $CheckData
);
 
$Response=$this->client->runTransaction($this->token, $Request);
 
$TransactionObject=$this->client->getTransaction($this->token, $Response->RefNum);
 
echo $TransactionObject->CheckData->AccountType;
 
?>

.NET VB

            Dim tran As usaepay.TransactionRequestObject = new usaepay.TransactionRequestObject
            Dim CheckData As  usaepay.CheckData = new usaepay.CheckData
            CheckData.Account = "1112223333"
            CheckData.Routing = "123456789"
            CheckData.DriversLicense = "D5555555"
            CheckData.DriversLicenseState = "CA"
            tran.CheckData = CheckData

.NET C#

usaepay.TransactionRequestObject tran = new usaepay.TransactionRequestObject();
 
            tran.CheckData = new usaepay.CheckData();
            tran.CheckData.Account = "1112223333";
            tran.CheckData.Routing = "123456789";
            tran.CheckData.DriversLicense = "D5555555";
            tran.CheckData.DriversLicenseState = "CA";

XML

<CheckData xsi:type="ns1:CheckData">
<Account xsi:type="xsd:string">XXXXX3456</Account>
<AccountType xsi:type="xsd:string">Savings</AccountType>
<CheckNumber xsi:type="xsd:integer">321</CheckNumber>
<DriversLicense xsi:type="xsd:string">XXXXX3123</DriversLicense>
<DriversLicenseState xsi:type="xsd:string">NA</DriversLicenseState>
<RecordType xsi:type="xsd:string">ARC</RecordType>
<Routing xsi:type="xsd:string">XXXXX6789</Routing>
</CheckData>

Change History

Version Change
1.4 Remove SSN parameter, Add AuxOnUS, EpcCode, FrontImage and BackImage parameters
1.0 Addition of AccountType Property: denotes type of account being debited.
developer/soap-1.4/objects/checkdata.txt · Last modified: 2010/09/09 16:50 by irina

Page Tools