FrontStream - Documentation to Collect Contract Information

This web service allows for managing different properties of contracts via integration. This can be accessed by using this URL:

https://secure.ftipgw.com/admin/ws/recurring.asmx?op=ManageContract

Descriptions of the parameters are listed below.

Parameter	Description
Username	Required. The username of the admin user.
TransType	Required. The type of transaction being performed. The valid values are: 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 UPDATE and ADD. The numerical information Key. This is dependent for the PaymentType. If you set the Payment Type to CC then the information that needs to be passed in this field is the CCInfoKey or CardInfoKey. Now if CK was set at the PaymentType, then the information that needs to go in this field is the CheckInfoKey. Please make sure that you are passing the right key based on the PaymentType.
PaymentType	Required for TransType ADD and UPDATE. Type of payment:CC for Credit Card and CK for Check
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.
Title	Optional. The customer’s title.
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, for example, USA or CAN.
DayPhone	Optional. The customer’s day phone.
NightPhone	Optional.The customer’s evening phone.
Fax	Optional. The customer’s fax number.
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	Optional. 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.
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.
NextBillDt	Required. This is required for TRANSTYPE ADD and UPDATE.
BillingPeriod	Required. Specifies the Billing Period Type, used in conjunction with BillingInterval to compute the next bill date.
BillingInterval	Required. Depending on the billing period, it can mean different things such as:DAY = every X number of days,WEEK = number of times per week,MONTH = number fo times per month;YEAR = number of times per year.
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.
Status	Optional. Status of the contract.
ExtData	Optional. Extended Data.

Example

Response

– <RecurringResult xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”http://www.tpisoft.com/Admin/ws”>

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

Secure Electronic Payments API