This Web Service provides methods that manages reucrring billing.

The following operations are supported. For a formal definition, please review the Service Description.

• AddRecurringCheck
  

  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 value are empty string for string type and 0 for integer type.

  Parameters
  

  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 unique identifier for the customer.
  CustomerName	(Required) The customer's name.
  FirstName	(Optional) The customer's first name.
  LastName	(Optional) The customer's last name.
  Title	(Optional) The customer's title.
  Department	(Optional) The customer's 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 characters State Code.
  Province	(Optional) The customer's province if it is outside of the USA.
  Zip	(Optional) The customer's zip code if in USA, postal code if outside of USA.
  CountryID	(Optional) The customer's 3 characters country code. e.g. USA, CAN
  Email	(Optional) The customer's email address.
  DayPhone	(Optional) The customer's day phone.
  Fax	(Optional) The customer's fax.
  Mobile	(Optional) The customer's mobile phone.
  ContractID	(Required) The merchant supplied unique identifier for the contract.
  ContractName	(Optional) The contract's name.
  BillAmt	(Required) Bill amount.
  TaxAmt	(Optional) Tax amount.
  TotalAmt	(Required) BillAmt + TaxAmt = Total amount
  StartDate	(Required) The start date of the contract.
  EndDate	(Optional) The end date of the contract. If this date is not given, the contract will continue to run until it is manually cancelled or suspended by the system due to failure of payment.
  BillingPeriod	(Required) Specifies Billing Period Type, used in conjunction with BillingInterval to compute the next bill date. DAY - every x days WEEK - number of times per week MONTH - number of times per month YEAR - number of times per year
  BillingInterval	(Required) Depending on the BillingPeriod, it means different things. e.g. every x days, number of times per week, number of times per month, number of times per year
  MaxFailures	(Optional) The number of times the system will retry when a recurring paymnet fails to process before it put the contract in suspend mode.
  FailureInterval	(Optional) Number of days the system will wait after each retry when the payment fails.
  EmailCustomer	(Optional) TRUE/FALSE - Whether to email the customer regarding the status of the recurring payment.
  EmailMerchant	(Optional) TRUE/FALSE - Whether to email the merchant regarding the status of the recurring payment.
  EmailCustomerFailure	(Optional) TRUE/FALSE - Whether to email the customer when the recurring payment fails.
  EmailMerchantFailure	(Optional) TRUE/FALSE - Whether to email the merchant when the recurring payment fails.
  CheckType	(Required) PERSONAL BUSINESS
  AccountType	(Required) CHECKING SAVINGS
  CheckNum	(Optional) Check Number
  MICR	(Optional) The scanned check MICR data.
  AccountNum	(Required) The account number.
  TransitNum	(Required) The transit / routing number.
  SS	(Optional) Social Security number of the check holder.
  DOB	(Optional) Date of Birth of the check holder.
  BranchCity	(Optional) The city of the Bank where account is located.
  DL	(Optional) The driver license of the check holder.
  StateCode	(Optional) The 2 characters State Code of the driver license of the check holder.
  NameOnCheck	(Optional) The check holder's name as it is on the check.
  ExtData	(Optional) Extended Data.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction

• AddRecurringCreditCard
  

  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 value are empty string for string type and 0 for integer type.

  Parameters
  

  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 unique identifier for the customer.
  CustomerName	(Required) The customer's name.
  FirstName	(Optional) The customer's first name.
  LastName	(Optional) The customer's last name.
  Title	(Optional) The customer's title.
  Department	(Optional) The customer's 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 characters State Code.
  Province	(Optional) The customer's province if it is outside of the USA.
  Zip	(Optional) The customer's zip code if in USA, postal code if outside of USA.
  CountryID	(Optional) The customer's 3 characters country code. e.g. USA, CAN
  Email	(Optional) The customer's email address.
  DayPhone	(Optional) The customer's day phone.
  Fax	(Optional) The customer's fax.
  Mobile	(Optional) The customer's mobile phone.
  ContractID	(Required) The merchant supplied unique identifier for the contract.
  ContractName	(Optional) The contract's name.
  BillAmt	(Required) Bill amount.
  TaxAmt	(Optional) Tax amount.
  TotalAmt	(Required) BillAmt + TaxAmt = Total amount
  StartDate	(Required) The start date of the contract.
  EndDate	(Optional) The end date of the contract. If this date is not given, the contract will continue to run until it is manually cancelled or suspended by the system due to failure of payment.
  BillingPeriod	(Required) Specifies Billing Period Type, used in conjunction with BillingInterval to compute the next bill date. DAY - every x days WEEK - number of times per week MONTH - number of times per month YEAR - number of times per year
  BillingInterval	(Required) Depending on the BillingPeriod, it means different things. e.g. every x days, number of times per week, number of times per month, number of times per year
  MaxFailures	(Optional) The number of times the system will retry when a recurring paymnet fails to process before it put the contract in suspend mode.
  FailureInterval	(Optional) Number of days the system will wait after each retry when the payment fails.
  EmailCustomer	(Optional) TRUE/FALSE - Whether to email the customer regarding the status of the recurring payment.
  EmailMerchant	(Optional) TRUE/FALSE - Whether to email the merchant regarding the status of the recurring payment.
  EmailCustomerFailure	(Optional) TRUE/FALSE - Whether to email the customer when the recurring payment fails.
  EmailMerchantFailure	(Optional) TRUE/FALSE - Whether to email the merchant when the recurring payment fails.
  CcAccountNum	(Required) Credit Card Account Number
  CcExpDate	(Required) 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.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction

• GetContractDetails
  

  Retrieves contract info associated with a given user.

  Parameters
  

  username	(Required) The username of the admin user.
  password	(Required) The password of the admin user.
  merchantKey	(optional) The merchant key to limit the results by. Only applies to reseller/admin users.
  customerKey	(optional) The customer key to limit the results by.
  contractKey	(optional) The contract key to limit the results by.
  contractId	(optional) The contract id to limit the results by.
  startDate	(optional) The minimum date of the start of the contract.
  endDate	(optional) The maximum date of the start of the contract.

  
  
• ManageCheckInfo
  
  Parameters
  

  Username	(Required) The username of the admin user.
  Password	(Required) The password of the admin user.
  TransType	(Required) The type of transaction being performed: ADD UPDATE DELETE
  Vendor	(Required) The numerical Vendor/Merchant key.
  CustomerKey	(Required) The numerical Customer key.
  CheckInfoKey	(Required for TransType UPDATE and DELETE) The numerical Check Info key.
  CheckType	(Required) PERSONAL BUSINESS
  AccountType	(Required) CHECKING SAVINGS
  CheckNum	(Optional) The check number.
  MICR	(Optional) The scanned check MICR data.
  AccountNum	(Required) The account number.
  TransitNum	(Required) The transit / routing number.
  SS	(Optional) Social Security number of the check holder.
  DOB	(Optional) Date of Birth of the check holder.
  BranchCity	(Optional) The city of the Bank where account is located.
  DL	(Optional) The driver license of the check holder.
  StateCode	(Optional) The 2 characters State Code of the driver license of the check holder.
  NameOnCheck	(Optional) The check holder's name as it is on the check.
  Email	(Optional) The customer's email address.
  DayPhone	(Optional) The customer's day phone.
  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 characters State Code.
  Province	(Optional) The customer's province if it is outside of the USA.
  PostalCode	(Optional) The customer's zip code if in USA, postal code if outside of USA.
  CountryID	(Optional) The customer's 3 characters country code. e.g. USA, CAN
  ExtData	(Optional) Extended Data.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction

• ManageContract
  
  Parameters
  

  Username	(Required) The username of the admin user.
  Password	(Required) The password of the admin user.
  TransType	(Required) The type of transaction being performed: ADD UPDATE DELETE
  Vendor	(Required) The numerical Vendor/Merchant key.
  CustomerKey	(Required) The numerical Customer key.
  ContractKey	(Required for TransType UPDATE and DELETE) The numerical Contract key.
  PaymentInfoKey	(Required for TransType ADD and UPDATE) The numerical Payment Info key.
  PaymentType	(Required for TransType ADD and UPDATE) Type of payment: CC - Credit Card CK - Check
  CustomerID	(Required for TransType ADD and UPDATE) A merchant supplied unique identifier for the customer.
  CustomerName	(Optional) The customer's name.
  FirstName	(Optional) The customer's first name.
  LastName	(Optional) The customer's last name.
  Title	(Optional) The customer's title.
  Department	(Optional) The customer's 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 characters State Code.
  Province	(Optional) The customer's province if it is outside of the USA.
  Zip	(Optional) The customer's zip code if in USA, postal code if outside of USA.
  CountryID	(Optional) The customer's 3 characters country code. e.g. USA, CAN
  Email	(Optional) The customer's email address.
  DayPhone	(Optional) The customer's day phone.
  NightPhone	(Optional) The customer's evening phone.
  Fax	(Optional) The customer's fax.
  Mobile	(Optional) The customer's mobile phone.
  ContractID	(Required for TransType ADD and UPDATE) The merchant supplied unique identifier for the contract.
  ContractName	(Optional) The contract's name.
  BillAmt	(Required for TransType ADD and UPDATE) Bill amount.
  TaxAmt	(Optional) Tax amount.
  TotalAmt	(Required for TransType ADD and UPDATE) BillAmt + TaxAmt = Total amount
  StartDate	(Required for TransType ADD and UPDATE) The start date of the contract.
  EndDate	(Required for TransType ADD and UPDATE) The end date of the contract. If this date is not given, the contract will continue to run until it is manually cancelled or suspended by the system due to failure of payment.
  NextBillDt	(Required for TransType ADD and UPDATE)
  BillingPeriod	(Required for TransType ADD and UPDATE) Specifies Billing Period Type, used in conjunction with BillingInterval to compute the next bill date. DAY - every x days WEEK - number of times per week MONTH - number of times per month YEAR - number of times per year
  BillingInterval	(Required for TransType ADD and UPDATE) Depending on the BillingPeriod, it means different things. e.g. every x days, number of times per week, number of times per month, number of times per year
  MaxFailures	(Optional) The number of times the system will retry when a recurring paymnet fails to process before it put the contract in suspend mode.
  FailureInterval	(Optional) Number of days the system will wait after each retry when the payment fails.
  EmailCustomer	(Optional) TRUE/FALSE - Whether to email the customer regarding the status of the recurring payment.
  EmailMerchant	(Optional) TRUE/FALSE - Whether to email the merchant regarding the status of the recurring payment.
  EmailCustomerFailure	(Optional) TRUE/FALSE - Whether to email the customer when the recurring payment fails.
  EmailMerchantFailure	(Optional) TRUE/FALSE - Whether to email the merchant when the recurring payment fails.
  Status	(Optional) Status of contract.
  ExtData	(Optional) Extended Data. PONUM is used if you want to pass a PO number for purchase cards.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction

• ManageContractAddDaysToNextBillDt
• ManageCreditCardInfo
  
  Parameters
  

  Username	(Required) The username of the admin user.
  Password	(Required) The password of the admin user.
  TransType	(Required) The type of transaction being performed: ADD UPDATE DELETE
  Vendor	(Required) The numerical Vendor/Merchant key.
  CustomerKey	(Required) The numerical Customer key.
  CardInfoKey	(Required) The numerical Credit Card Info key.
  CcAccountNum	(Required) Credit Card Account Number
  CcExpDate	(Required) 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.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction

• ManageCustomer
  
  Parameters
  

  Username	(Required) The username of the admin user.
  Password	(Required) The password of the admin user.
  TransType	(Required) The type of transaction being performed: ADD UPDATE DELETE
  Vendor	(Required) The numerical Vendor/Merchant key.
  CustomerKey	(Required for TransType UPDATE and DELETE) The numerical Customer key.
  CustomerID	(Required) A merchant supplied unique identifier for the customer.
  CustomerName	(Optional) The customer's name.
  FirstName	(Optional) The customer's first name.
  LastName	(Optional) The customer's last name.
  Title	(Optional) The customer's title.
  Department	(Optional) The customer's 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 characters State Code.
  Province	(Optional) The customer's province if it is outside of the USA.
  Zip	(Optional) The customer's zip code if in USA, postal code if outside of USA.
  CountryID	(Optional) The customer's 3 characters country code. e.g. USA, CAN
  Email	(Optional) The customer's email address.
  DayPhone	(Optional) The customer's day phone.
  NightPhone	(Optional) The customer's evening phone.
  Fax	(Optional) The customer's fax.
  Mobile	(Optional) The customer's mobile phone.
  Status	(Optional) Status of contract.
  ExtData	(Optional) Extended Data.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction

• ProcessCheck
  
  Parameters
  

  Username	(Required) The username of the admin user.
  Password	(Required) The password of the admin user.
  Vendor	(Required) The numerical Vendor/Merchant key.
  CheckInfoKey	(Required) The numerical Check Payment Info key.
  Amount	(Required) Amount check is for.
  InvNum	(Optional) The associated invoice number.
  ExtData	(Optional) Extended Data.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction

• ProcessCreditCard
  
  Parameters
  

  Username	(Required) The username of the admin user.
  Password	(Required) The password of the admin user.
  Vendor	(Required) The numerical Vendor/Merchant key.
  CcInfoKey	(Required) The numerical Credit Card Payment Info key.
  Amount	(Required) Amount check is for.
  InvNum	(Optional) The associated invoice number.
  ExtData	(Optional) Extended Data.

  
  

  Returns
  RecurringResult including keys of the newly added/updated records if the call is successful.

  • Username - The admin user
  • Partner - The reseller of the merchant
  • Vendor - The merchant key
  • CustomerKey - Customer Key
  • CcInfoKey - Credit Card Payment Info Key
  • CheckInfoKey - Check Payment Info Key
  • ContractKey - Contract Key
  • code - result code: 0 - success, error otherwise
  • error - description of the erorr
  • Result - payment transaction result: 0 - approved, decline otherwise
  • AuthCode - Authorization code for payment transaction
  • PNRef - unique reference number for the payment transaction, returned by the payment server
  • Message - description of the payment transaction