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.

TransType

R

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

•      ADD

•      UPDATE

•      DELETE

*Note: Passing in ‘NULL’ values to this service with a TransType of ‘UPDATE’ will override existing values to ‘NULL’. It is very important that all data be updated when making this web service call.

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.

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.

Customer ID

R

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

Note: The CustomerID 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 CustomerID appears in the Customer ID column.

CustomerName

R

Individual or customer business name.

Note: The CustomerName 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 CustomerName appears in the Customer Name column.

FirstName

O

Customer contact first name.

LastName

O

Customer contact last name.

Title

O

Customer contact job or professional title. For example, “Business Unit Manager,” or “Dr.”

Department

O

Customer contact department. For example, “Sales,” or “Operations.”

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).

Note: Valid entries are standard U.S. Postal service two-character state codes. For more information, see http://www.usps.com/ncsc/lookups/usps_abbreviations.html

Province

O

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

Zip

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.

DayPhone

O

Customer contact’s daytime phone number.

NightPhone

O

Customer contact’s after-hours phone number.

Fax

O

Customer contact’s fax number.

Email

O

Customer contact’s email address.

Mobile

O

Customer contact’s mobile phone number.

Status

O

Indicates whether the customer record is currently active or inactive. Valid values are:

•      ACTIVE

•      INACTIVE

•      PENDING

•      CLOSED

ExtData

O

Reserved for future use.