Recurring
Click here for a complete list of operations.
GetToken
Retrives CCInfoKey for User.
ParametersClientSessionID | (Required) ClientSessionID to identify user. |
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. |
FirstName | (Optional) The customer's first name. |
LastName | (Optional) The customer's last name. |
Returns
RecurringResult including keys of the newly added records if the call is successful.
- ClientSessionID - ClientSessionID provided in request.
- CcInfoKey - Credit Card Payment Info Key
- code - result code: OK - success, error otherwise
- error - description of the error
- Result - payment transaction result: 0 - approved, decline otherwise
- CustomerKey - Customer Key
- CustomerID - Customer ID
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /admin/ws/recurring.asmx HTTP/1.1 Host: secure.ftipgw.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.tpisoft.com/Admin/ws/GetToken" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetToken xmlns="http://www.tpisoft.com/Admin/ws"> <ClientSessionID>string</ClientSessionID> <CcAccountNum>string</CcAccountNum> <CcExpDate>string</CcExpDate> <CcNameOnCard>string</CcNameOnCard> <CcStreet>string</CcStreet> <CcZip>string</CcZip> <FirstName>string</FirstName> <LastName>string</LastName> </GetToken> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetTokenResponse xmlns="http://www.tpisoft.com/Admin/ws"> <GetTokenResult> <CustomerID>string</CustomerID> <ClientSessionID>string</ClientSessionID> <CustomerKey>string</CustomerKey> <ContractKey>string</ContractKey> <CcInfoKey>string</CcInfoKey> <CheckInfoKey>string</CheckInfoKey> <code>OK or Unknown_Error or Access_Denied or Invalid_Login or Invalid_User_Status or Invalid_User or User_Not_Found or Username_Already_In_Use or Username_Has_Invalid_Characters or Not_Enough_Privilege or Invalid_PartnerID or Invalid_VendorID or Invalid_Argument or Invalid_Record or Transaction_Type_Not_Supported_By_Host or Internal_Error or Invalid_ProcessorID or Processor_Not_Found or InValidPassword</code> <error>string</error> <Partner>string</Partner> <Vendor>string</Vendor> <Username>string</Username> <Result>string</Result> <AuthCode>string</AuthCode> <PNRef>string</PNRef> <Message>string</Message> <Contracts> <ContractInfo> <Contract_Key>string</Contract_Key> <Next_Bill_Date>string</Next_Bill_Date> </ContractInfo> <ContractInfo> <Contract_Key>string</Contract_Key> <Next_Bill_Date>string</Next_Bill_Date> </ContractInfo> </Contracts> <ContractTransactions> <LastContractTrans> <PaymentPref>string</PaymentPref> <Contract_Key>string</Contract_Key> <Transaction_Date>string</Transaction_Date> <Transaction_Amount>string</Transaction_Amount> <Convenience_Fee>string</Convenience_Fee> <PNRef>string</PNRef> <ResultCode>string</ResultCode> <ResponseMessage>string</ResponseMessage> <AuthCode>string</AuthCode> </LastContractTrans> <LastContractTrans> <PaymentPref>string</PaymentPref> <Contract_Key>string</Contract_Key> <Transaction_Date>string</Transaction_Date> <Transaction_Amount>string</Transaction_Amount> <Convenience_Fee>string</Convenience_Fee> <PNRef>string</PNRef> <ResultCode>string</ResultCode> <ResponseMessage>string</ResponseMessage> <AuthCode>string</AuthCode> </LastContractTrans> </ContractTransactions> <AccountNumber>string</AccountNumber> </GetTokenResult> </GetTokenResponse> </soap:Body> </soap:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /admin/ws/recurring.asmx/GetToken?ClientSessionID=string&CcAccountNum=string&CcExpDate=string&CcNameOnCard=string&CcStreet=string&CcZip=string&FirstName=string&LastName=string HTTP/1.1 Host: secure.ftipgw.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <RecurringResult xmlns="http://www.tpisoft.com/Admin/ws"> <CustomerID>string</CustomerID> <ClientSessionID>string</ClientSessionID> <CustomerKey>string</CustomerKey> <ContractKey>string</ContractKey> <CcInfoKey>string</CcInfoKey> <CheckInfoKey>string</CheckInfoKey> <code>OK or Unknown_Error or Access_Denied or Invalid_Login or Invalid_User_Status or Invalid_User or User_Not_Found or Username_Already_In_Use or Username_Has_Invalid_Characters or Not_Enough_Privilege or Invalid_PartnerID or Invalid_VendorID or Invalid_Argument or Invalid_Record or Transaction_Type_Not_Supported_By_Host or Internal_Error or Invalid_ProcessorID or Processor_Not_Found or InValidPassword</code> <error>string</error> <Partner>string</Partner> <Vendor>string</Vendor> <Username>string</Username> <Result>string</Result> <AuthCode>string</AuthCode> <PNRef>string</PNRef> <Message>string</Message> <Contracts> <ContractInfo> <Contract_Key>string</Contract_Key> <Next_Bill_Date>string</Next_Bill_Date> </ContractInfo> <ContractInfo> <Contract_Key>string</Contract_Key> <Next_Bill_Date>string</Next_Bill_Date> </ContractInfo> </Contracts> <ContractTransactions> <LastContractTrans> <PaymentPref>string</PaymentPref> <Contract_Key>string</Contract_Key> <Transaction_Date>string</Transaction_Date> <Transaction_Amount>string</Transaction_Amount> <Convenience_Fee>string</Convenience_Fee> <PNRef>string</PNRef> <ResultCode>string</ResultCode> <ResponseMessage>string</ResponseMessage> <AuthCode>string</AuthCode> </LastContractTrans> <LastContractTrans> <PaymentPref>string</PaymentPref> <Contract_Key>string</Contract_Key> <Transaction_Date>string</Transaction_Date> <Transaction_Amount>string</Transaction_Amount> <Convenience_Fee>string</Convenience_Fee> <PNRef>string</PNRef> <ResultCode>string</ResultCode> <ResponseMessage>string</ResponseMessage> <AuthCode>string</AuthCode> </LastContractTrans> </ContractTransactions> <AccountNumber>string</AccountNumber> </RecurringResult>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /admin/ws/recurring.asmx/GetToken HTTP/1.1 Host: secure.ftipgw.com Content-Type: application/x-www-form-urlencoded Content-Length: length ClientSessionID=string&CcAccountNum=string&CcExpDate=string&CcNameOnCard=string&CcStreet=string&CcZip=string&FirstName=string&LastName=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <RecurringResult xmlns="http://www.tpisoft.com/Admin/ws"> <CustomerID>string</CustomerID> <ClientSessionID>string</ClientSessionID> <CustomerKey>string</CustomerKey> <ContractKey>string</ContractKey> <CcInfoKey>string</CcInfoKey> <CheckInfoKey>string</CheckInfoKey> <code>OK or Unknown_Error or Access_Denied or Invalid_Login or Invalid_User_Status or Invalid_User or User_Not_Found or Username_Already_In_Use or Username_Has_Invalid_Characters or Not_Enough_Privilege or Invalid_PartnerID or Invalid_VendorID or Invalid_Argument or Invalid_Record or Transaction_Type_Not_Supported_By_Host or Internal_Error or Invalid_ProcessorID or Processor_Not_Found or InValidPassword</code> <error>string</error> <Partner>string</Partner> <Vendor>string</Vendor> <Username>string</Username> <Result>string</Result> <AuthCode>string</AuthCode> <PNRef>string</PNRef> <Message>string</Message> <Contracts> <ContractInfo> <Contract_Key>string</Contract_Key> <Next_Bill_Date>string</Next_Bill_Date> </ContractInfo> <ContractInfo> <Contract_Key>string</Contract_Key> <Next_Bill_Date>string</Next_Bill_Date> </ContractInfo> </Contracts> <ContractTransactions> <LastContractTrans> <PaymentPref>string</PaymentPref> <Contract_Key>string</Contract_Key> <Transaction_Date>string</Transaction_Date> <Transaction_Amount>string</Transaction_Amount> <Convenience_Fee>string</Convenience_Fee> <PNRef>string</PNRef> <ResultCode>string</ResultCode> <ResponseMessage>string</ResponseMessage> <AuthCode>string</AuthCode> </LastContractTrans> <LastContractTrans> <PaymentPref>string</PaymentPref> <Contract_Key>string</Contract_Key> <Transaction_Date>string</Transaction_Date> <Transaction_Amount>string</Transaction_Amount> <Convenience_Fee>string</Convenience_Fee> <PNRef>string</PNRef> <ResultCode>string</ResultCode> <ResponseMessage>string</ResponseMessage> <AuthCode>string</AuthCode> </LastContractTrans> </ContractTransactions> <AccountNumber>string</AccountNumber> </RecurringResult>