Parameter Name

Opt/Req

Description

UserName

R

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

Password

R

Password associated with the user name provided.

Vendor

R

Unique numeric value used to identify the merchant.

Note: Vendor key may also be called Merchant ID, Merchant Number, or RPNum. To locate your Vendor key on the virtual terminal, click Password under the Preferences menu.

TransType

R

Indicates whether the payment type is being added, updated, or deleted. Valid entries are:

•      ADD

•      UPDATE

•      DELETE

CustomerKey

R

Unique identifier assigned to the customer record by the system at the time the customer record is created.

Note: The CustomerKey value can be found on the virtual terminal by accessing the View Customers option under the Recurring Billing menu. Display a list of customers by entering search criteria. The CustomerKey appears in the Key column.

CheckInfoKey

R*

Numerical key value assigned to the payment method when it was added to the system.

CheckType

R

Identifies the type of check as a personal or business check. Valid values are:

•      PERSONAL – Check is made from an individual (personal) checking account

•      BUSINESS – Check is made from a business checking account

AccountType

R

Indicates whether the funds come from a checking or savings account. Valid values are:

•      CHECKING – Check is made from a standard checking account or ACH

•      SAVINGS – Check is made from a savings account

CheckNum

O

Uniquely identifies an individual’s check.

MICR

O

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

Note: This parameter should be used if the developer knows the precise format for the MICR that is supported by the check processor. If the precise format is unknown, the raw MICR should also be included with the transaction. See the <RawMICR> tag under the ExtData parameter for additional information.

AccountNum

R

Uniquely identifies the check owner’s bank account.

TransitNum

R

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

RawMICR

O

The raw MICR format certain check readers produce.

SS

O

Check owner’s Social Security number.

DOB

O

Check owner’s date of birth.

BranchCity

O

City where the issuing bank branch is located.

DL

O

Check owner’s driver’s license number.

StateCode

O

Check owner’s standard U.S. postal service two-character state code or other standard province code.

Note: Valid entries should follow USPS two-character state code standards. For more information, see http://www.usps.com/ncsc/lookups/usps_abbreviations.html

Note: See Developer Notes for invalid character processing.

NameOnCheck

O

Check owner’s name as it appears on the check.

Note: See Developer Notes for invalid character processing.

Email

O

Customer contact’s email address.

DayPhone

O

Customer contact’s phone number.

Street1

O

Customer contact street address – line 1.

Street2

O

Customer contact street address – line 2.

Street3

O

Customer contact street address – line 3.

City

O

Customer contact city.

StateID

O

Customer contact’s standard U.S. postal service two-character state code (U.S. customers only).

Province

O

Customer contact’s province (countries outside the U.S., only).           

PostCode

O

Customer contact’s zip or postal code.

CountryID

O

Customer contact’s three-character country code. For example, USA = United States or CAN = Canada

ExtDate

O

Reserved for future use.