This web service operation allows you to add a customer, a contract and a credit card payment method all in one call. All parameters marked as required must be supplied.Optional parameters can be left blank and the default value will be used. Default values are empty strings for string type and 0 for integer type. The URL to access this web service is: Descriptions of the parameters are listed below.

Parameter Description
Username Required. The username of the admin user.
Password Required. The password of the admin user
Vendor Required. The numerical Vendor/Merchant Key.
CustomerID Required. A merchant supplied a unique indentifier for a customer.
Customer Name Required. The customer’s name is to be submitted in this field.
FirstName Optional. The customer’s first name.
LastName Optional. The customer’s last name.
Department Optional. The customer’ department.
Street1 Optional. The customer’s street address 1.
Street2 Optional. The customer’s street address 2.
Street3 Optional. The customer’s street address 3.
City Optional. The customer’s city.
StateID Optional. The customer’s 2 character State Code
Province Optional. The customer’s province if it is outside the USA
Zip Optional. The customer’s zip code if in the USA, postal code if outside the USA
CountryID Optional. The customer’s 3 character country code. Valid values are: USA, CAN, or null/blank. If null/blank, CountryID is set to USA.
Email Optional. The customer’s email address.
Mobile Optional. The customer’s mobile phone.
ContractID Required. The merchant supplied unique indentifier for the contract.
ContractName Optional. The contract’s name.
BillAmt Required. The amount to be billed in relation to the contract.
TaxAmt Optional. The tax amount.
TotalAmt Required. This is the total amount. BillAmt + TaxAmt = TotalAmt.
StartDate Required. The start date of the contract. Must be tomorrow’s date or later. Using today’s date will get an error.
EndDate Optional. The end date of the contract. If this date is not given, the contract will continue to run until manually cancelled or suspended by the system due to failure of payment
BillingPeriod Required. Specifies the Billing Period Type, used in conjunction with BillingInterval to compute the next bill date that the contract will execute. Valid values are: DAY, WEEK, MONTH, YEAR

Required. Depending on the BillingPeriod value, it can mean different things:

  • DAY = every X number of days
  • WEEK = number of times per week
  • MONTH = number of times per month
  • YEAR = number of times per year.


  • To bill quarterly (i.e. every 3 months. i.e. 4 times per year), use BillingPeriod YEAR and BillingInterval 4
  • To bill semi-annually (every 6 months), use BillingPeriod YEAR and BillingInterval 2.
  • To bill twice a month (e.g. on the 15th and at the end of the month, assuming you set StartDate appropriately), use BillingPeriod MONTH and BillingInterval 2
  • To bill every two weeks, use BillingPeriod DAY and BillingInterval 14
  • To bill every week, use BillingPeriod WEEK and BillingInterval 1
  • To bill annually, use BillingPeriod YEAR and BillingInterval 1
MaxFailures Optional. The number of times the system will wait after each retry when a recurring payment fails to process before it puts the contract in suspended mode.
FailureInterval Optional. Number of days the system will wait after each payment retry when the payment fails.
EmailCustomer Optional. TRUE/FALSE setting whether to email the customer regarding the status of the recurring payment.
EmailMerchant Optional. TRUE/FALSE setting whether to email the merchant regarding the status of recurring payment.
EmailCustomerFailure Optional. TRUE/FALSE setting whether to email the customer when the recurring payment fails.
EmailMerchantFailure Optional. TRUE/FALSE setting whether to email the merchant when the recurring payemt fails.
CcAccountNum Required. The customer’s credit card number.
CcExpdate Required. The credit card expiration date.
CcNameOnCard Optional. The Card Holder’s name as it is on the card.
CcStreet Optional. The Card Holder’s billing address
CcZip Optional. The Card Holder’s billing zip code.
ExtData Optional. Extended Data.

Example Response <?xml version="1.0" encoding="utf-8" ?>  - <RecurringResult xmlns:xsd="" xmlns:xsi="" xmlns=""> <CustomerKey>11</CustomerKey> <ContractKey>7</ContractKey> <CcInfoKey>26607</CcInfoKey> <CheckInfoKey /> <code>OK</code> <error>OK</error> <Partner>100</Partner> <Vendor>1</Vendor> <Username>vital</Username> </RecurringResult>