Parameter Name

Opt/Req

Description

UserName

R

User name assigned in the payment server. The user must have an appropriate level of access in order to utilize the web service.

Password

R

Password associated with the user name provided.

TransType

R

Identifies the type of check transaction being made. Valid values are:

•      Sale - make a purchase using a check

•      Auth (Verify) - authorizes or verifies the amount of a check

•      Return - return the money of a settled check transaction to the check holder

•      Void - undo a settled check transaction

•      Force - (ForceSale) force a previous Sale transaction into the current batch

Terminal-based Processors Only:

•      Capture - settle a single transaction in the current batch

•      CaptureAll - settle all transactions in the current batch

Note: If using the Return, Void, Force, or Capture TransTypes, you must include a PNRef using the ExtData parameter.

Note: If using the Sale or Return TransTypes, you may be required to include city of account, bill-to street, and bill-to postal code using the ExtData parameter.

CheckNum

R*

Uniquely identifies an individual’s check.

TransitNum

R*

Uniquely identifies the bank holding funds. Also called routing number.

AccountNum

R*

Uniquely identifies the check owner’s bank account.

Amount

R*

Total transaction value in DDDD.CC format.

MICR

R^$

Magnetic Ink Check Reader data line. This data string includes the TransitNum and AccountNum.

Note: This input is required for processing check/consumer present transactions.

Note: The formats of the MICR is processor specific and if the developer is not sure about what format your Check processor accepts, pass the RAW MICR as well in the TOAD format and details of this are described in the extended data. If the developer is sure about the precise format for MICR that is supported by the Check processor, then there is no need to pass the Raw MICR in TOAD format.

NameOnCheck

R*

Check owner’s name as it appears on the check. See ‘Developer Notes’ for invalid character processing.

Note: This parameter may be required depending on the merchant’s processor setup.

DL

O

Check owner’s driver’s license number. See ‘Developer Notes’ for invalid character processing.

SS

O

Check owner’s Social Security number. See ‘Developer Notes’ for invalid character processing.

DOB

O

Check owner’s date of birth. See ‘Developer Notes’ for date formats.

StateCode

O

Check owner’s two-character state code. See ‘Developer Notes’ for invalid character processing.

Note: This parameter may be required depending on the merchant’s processor setup.

CheckType

O

Identifies the type of check used in the transaction. Valid values are:

•      Personal

•      Corporate

•      Government

ExtData

O

The ExtData parameter allows you to pass additional information to the web service that is not covered under the input parameters. ExtData values need not be placed in any particular order; however, they must be properly formatted using XML tags.

The following information may be added via the ExtData parameter:

Time out: (optional) Processor time out value in seconds. The default value for the parameter is 30 seconds. Valid format is:

•      <TimeOut>TimeOut</TimeOut> where TimeOut is the processor time out value in seconds.

PNRef: (required for TransType = Return, Void, Force, or Capture) Unique payment reference number used to identify a single transaction within the system. The payment reference number (PNRef) is assigned by the payment server at the time the transaction is created. Valid format is:

•      <PNRef>PNRef</PNRef> where PNRef is the valid payment reference number assigned to the transaction that is to be returned, voided, forced, or captured.

Phone: (optional) Check owner’s phone number. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <Phone>Phone</Phone> where Phone is the check owner’s phone number.

Email Address: (optional) Check owner’s email address. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <Email>Email</Email> where Email is the check owner’s email address.

Raw MICR: (Required for check/consumer present transactions) Raw Magnetic Ink Check Reader data line from the check reader. Valid format is:

•      <RawMICR>RawMICR</RawMICR> where RawMICR is the transit number, account number, and check number in the following format: TransitNumTAccountNumOCheckNum

Note: TOAD format is the accepted default format for raw MICR for all check processors supported.

Invoice Number: (optional) The invoice ID is assigned by the merchant. This identifier can be used to locate a specific transaction or multiple transactions grouped under a single invoice. Valid format is:

•      <InvNum>InvNum</InvNum> where InvNum is the merchant-assigned invoice number.

Note: Many merchants use the invoice ID to store other values in the database. The exact nature of the value stored will vary by merchant.

Training Mode: (optional) This is an indicator that specifies whether transactions will be processed for local loop back testing or treated normally. Valid formats are:

•      <TrainingMode>T</TrainingMode> where T (true) indicates that training mode is active and transactions are processed for local loop back testing.

•      <TrainingMode>F</TrainingMode> where F (false) indicates that training mode is inactive and transactions should be treated normally.

Alliance Number: (optional) Check alliance number. Valid format is:

•      <AllianceNum>AllianceNum</AllianceNum> where AllianceNum is the check’s alliance number.

Account Type: (optional) Identifies the bank account for the check as a checking account or savings account. Valid formats are:

•      <AccType>Checking</AccType> to indicate a checking account

•      <AccType>Savings</AccType> to indicate a savings account

City of Account (Depending on merchant setup, this may be required for TransType = Sale or Return) City name for the check owner’s residential address. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <CityOfAccount>CityOfAccount</CityOfAccount> where CityOfAccount is the check owner’s city name.

Bill-To Street: (Depending on merchant setup, this may be required for TransType = Sale or Return) Street address for the check owner’s bill-to address. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <BillToStreet>BillToStreet</BillToStreet> where BillToStreet is the street name for the check owner’s bill-to address.

Bill-To City: (optional) City name for the check owner’s bill-to address. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <BillToCity>BillToCity</BillToCity> where BillToCity is the city name for the check owner’s bill-to address.

Bill-To State: (optional) Two-character state code for the check owner’s bill-to address. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <BillToState>BillToState</BillToState> where BillToState is the two-character state code for the check owner’s bill-to address.

Bill-To Postal Code: (Depending on merchant setup, this may be required for TransType = Sale or Return) Postal/Zip code for the check owner’s bill-to address. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <BillToPostalCode>BillToPostalCode</BillToPostalCode> where BillToPostalCode is the street name for the check owner’s bill-to address.

Bill-To-Country: (optional) Country name for the check owner’s bill-to address. See ‘Developer Notes’ for invalid character processing. Valid format is:

•      <BillToCountry>BillToCountry</BillToCountry> where BillToCountry is the country name for the check owner’s bill-to address.

Customer ID: (optional) Identification number assigned to the customer by the merchant. Valid Format is:

•      <CustomerID>CustomerID</CustomerID> where CustomerID is the customer’s assigned customer ID.

Card Type: (optional) For use with image uploads specific to the processor RDM_ITMS. Valid format is:

•      <CardType>IMAGE<CardType>

External IP: (optional) When using the Transact web service, the IP address defaults to the calling computer's IP. If the request is coming from an external source, the external IP address can be substituted for the purpose of logging and fraud control.

To implement this IP pass through functionality, the following XML node should be included in the external data field of the web service call...

•      <ExternalIP>IP Address Here</ExternalIP>

If the ExternalIP node is not included in the external data field, then the default behavior of using the callers IP address is used.