developer:soap-1.6:objects:checkdata

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:objects:checkdata [2012/08/04 11:36] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​====== 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. ​ [[merchant:​checkformat|List of Check Record Types]] |
 +|String |MICR |MICR Data for Check 21 (optional, depending on processor)|
 +|String |AuxOnUS |MICR Data for Check 21 (optional, depending on processor)|
 +|String |EpcCode |MICR Data for Check 21 (optional, depending on processor)|
 +|String |FrontImage |Scan of front of check, base64 encoded (optional)|
 +|String |BackImage |Scan of back of check, base64 (optional)|
 +
 +
 +===== Places Used =====
 +
 +
 +[[..:​objects:​TransactionObject]]
 +[[..:​objects:​TransactionRequestObject]]
 +
 +
 +===== Examples =====
 +
 +==== PHP ====
 +
 +<code 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;​
 +
 +?> 
 +</​code> ​
 +
 +==== .NET VB ====
 +<code 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
 +</​code>​
 +
 +==== .NET C# ====
 +<code 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";​
 +
 +</​code>​
 +
 +==== XML ====
 +
 +<code 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>​
 +</​code>​
 +
 +===== Change History =====
 +
 +^Version ^Change ^
 +|[[developer:​soap-1.5:​objects:​checkdata|1.5]] |Add MICR parameter ​ |
 +|[[developer:​soap-1.4:​objects:​checkdata|1.4]] |Remove SSN parameter, ​ Add AuxOnUS, EpcCode, FrontImage and BackImage parameters ​ |
 +|[[developer:​soap-1.0:​objects:​checkdata|1.0]] | Addition of AccountType Property: denotes type of account being debited.|
developer/soap-1.6/objects/checkdata.txt ยท Last modified: 2012/08/04 11:36 by tem

Page Tools