Soap API v1.2


Run a new check sale transaction.


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.

See also runTransaction, runQuickSale, voidTransaction, overrideTransaction, runCheckCredit, runAuthOnly



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.



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

try {
    '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());


This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
  TransactionRequestObject params = new TransactionRequestObject();
  //set account holder name
    params.setAccountHolder("Test Joe");
    // populate transaction details
    TransactionDetail details = new TransactionDetail();
      details.setDescription("My Test Sale");
    // populate credit card data
    CheckData checkdata = new 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());


    Dim client As usaepay.usaepayService = New usaepay.usaepayService
    Dim token As usaepay.ueSecurityToken
    token = Me.CreateToken("982lz9VsLm87MA54Sv8E582h8OZMArL6", "443311")
    Dim transaction As usaepay.TransactionRequestObject = New usaepay.TransactionRequestObject
      transaction.CheckData = New usaepay.CheckData
        transaction.CheckData.Account = "1112223333"
        transaction.CheckData.Routing = "123456789"
        transaction.CheckData.DriversLicense = "D5555555"
        transaction.CheckData.DriversLicenseState = "CA"
      transaction.Details = New usaepay.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 usaepay.TransactionResponse = New usaepay.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)
      MsgBox("Transaction Error, Reason: " & response.Error)
    End If


<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="" xmlns:ns1="urn:usaepay"
 xmlns:xsd="" xmlns:xsi=""
<Token xsi:type="ns1:ueSecurityToken">
	<ClientIP xsi:type="xsd:string"></ClientIP>
	<PinHash xsi:type="ns1:ueHash">
		<HashValue xsi:type="xsd:string">673d067b9e414b11d3be405d3537fbf7bc359ffa</HashValue>
		<Seed xsi:type="xsd:string">12045764872012320491</Seed>
		<Type xsi:type="xsd:string">sha1</Type>
	<SourceKey xsi:type="xsd:string">nE3D6frKFj27U9ug1Yd2366e0062hepS</SourceKey>
<Params xsi:type="ns1:TransactionRequestObject">
	<AccountHolder xsi:type="xsd:string">Tester Jones 111</AccountHolder>
	<CheckData xsi:type="ns1:CheckData">
		<Account xsi:type="xsd:string">11111111</Account>
		<AccountType xsi:type="xsd:string">Savings</AccountType>
		<CheckNumber xsi:type="xsd:integer">1234</CheckNumber>
		<DriversLicense xsi:type="xsd:string">34521343</DriversLicense>
		<DriversLicenseState xsi:type="xsd:string">CA</DriversLicenseState>
		<RecordType xsi:type="xsd:string">PPD</RecordType>
		<Routing xsi:type="xsd:string">123456789</Routing>
	<Details xsi:type="ns1:TransactionDetail">
		<Amount xsi:type="xsd:double">4.99</Amount>
		<Description xsi:type="xsd:string">Example Transaction</Description>
		<Invoice xsi:type="xsd:string">44539</Invoice>

Change History

Version Change
1.0 Method added in soap v1.0
developer/soap/methods/runchecksale.txt · Last modified: 2009/09/10 12:42 by charlie

Page Tools