Recurring Web Service

Recurring

Click here for a complete list of operations.

GetTokenBillingData

Retrives Billing Data for Customer and Payment Associated with CCInfoKey/CheckInfoKey.

Parameters

Username	(Required) The username of the admin user.
Password	(Required) The password of the admin user.
Vendor	(Required) The numerical Vendor/Merchant key.
TokenInfoKey	(Required) The numerical Credit/Check Info key.
PaymentType	(Required) Token Type: CARD/CHECK.
ExtData	(Optional) Extended Data.

Returns
BillingDataResult including available data for the TokenInfoKey if the call is successful.

code - result code: OK - success, error otherwise
error - description of the error

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
Username:
Password:
Vendor:
TokenInfoKey:
PaymentType:
ExtData:

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/GetTokenBillingData"

<?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>
    <GetTokenBillingData xmlns="http://www.tpisoft.com/Admin/ws">
      <Username>string</Username>
      <Password>string</Password>
      <Vendor>string</Vendor>
      <TokenInfoKey>string</TokenInfoKey>
      <PaymentType>string</PaymentType>
      <ExtData>string</ExtData>
    </GetTokenBillingData>
  </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>
    <GetTokenBillingDataResponse xmlns="http://www.tpisoft.com/Admin/ws">
      <GetTokenBillingDataResult>
        <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>
        <CardFirstSix>string</CardFirstSix>
        <CardLastFour>string</CardLastFour>
        <CardType>string</CardType>
        <CardExpDate>string</CardExpDate>
        <CardNameOn>string</CardNameOn>
        <CardAvsZip>string</CardAvsZip>
        <CardAvsStreet>string</CardAvsStreet>
        <CheckAccountLastX>string</CheckAccountLastX>
        <CheckAccountType>string</CheckAccountType>
        <CheckType>string</CheckType>
        <CheckNameOn>string</CheckNameOn>
        <CheckRoutingNum>string</CheckRoutingNum>
        <CustomerCity>string</CustomerCity>
        <CustomerCountry>string</CustomerCountry>
        <CustomerID>string</CustomerID>
        <CustomerName>string</CustomerName>
        <CustomerEmail>string</CustomerEmail>
        <CustomerFirstName>string</CustomerFirstName>
        <CustomerLastName>string</CustomerLastName>
        <CustomerProvince>string</CustomerProvince>
        <CustomerState>string</CustomerState>
        <CustomerStreetAddress1>string</CustomerStreetAddress1>
        <CustomerStreetAddress2>string</CustomerStreetAddress2>
        <CustomerStreetAddress3>string</CustomerStreetAddress3>
        <CustomerZip>string</CustomerZip>
        <CustomerStatus>string</CustomerStatus>
        <CustomerKey>string</CustomerKey>
      </GetTokenBillingDataResult>
    </GetTokenBillingDataResponse>
  </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/GetTokenBillingData?Username=string&Password=string&Vendor=string&TokenInfoKey=string&PaymentType=string&ExtData=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"?>
<BillingDataResult xmlns="http://www.tpisoft.com/Admin/ws">
  <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>
  <CardFirstSix>string</CardFirstSix>
  <CardLastFour>string</CardLastFour>
  <CardType>string</CardType>
  <CardExpDate>string</CardExpDate>
  <CardNameOn>string</CardNameOn>
  <CardAvsZip>string</CardAvsZip>
  <CardAvsStreet>string</CardAvsStreet>
  <CheckAccountLastX>string</CheckAccountLastX>
  <CheckAccountType>string</CheckAccountType>
  <CheckType>string</CheckType>
  <CheckNameOn>string</CheckNameOn>
  <CheckRoutingNum>string</CheckRoutingNum>
  <CustomerCity>string</CustomerCity>
  <CustomerCountry>string</CustomerCountry>
  <CustomerID>string</CustomerID>
  <CustomerName>string</CustomerName>
  <CustomerEmail>string</CustomerEmail>
  <CustomerFirstName>string</CustomerFirstName>
  <CustomerLastName>string</CustomerLastName>
  <CustomerProvince>string</CustomerProvince>
  <CustomerState>string</CustomerState>
  <CustomerStreetAddress1>string</CustomerStreetAddress1>
  <CustomerStreetAddress2>string</CustomerStreetAddress2>
  <CustomerStreetAddress3>string</CustomerStreetAddress3>
  <CustomerZip>string</CustomerZip>
  <CustomerStatus>string</CustomerStatus>
  <CustomerKey>string</CustomerKey>
</BillingDataResult>

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/GetTokenBillingData HTTP/1.1
Host: secure.ftipgw.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&Vendor=string&TokenInfoKey=string&PaymentType=string&ExtData=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<BillingDataResult xmlns="http://www.tpisoft.com/Admin/ws">
  <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>
  <CardFirstSix>string</CardFirstSix>
  <CardLastFour>string</CardLastFour>
  <CardType>string</CardType>
  <CardExpDate>string</CardExpDate>
  <CardNameOn>string</CardNameOn>
  <CardAvsZip>string</CardAvsZip>
  <CardAvsStreet>string</CardAvsStreet>
  <CheckAccountLastX>string</CheckAccountLastX>
  <CheckAccountType>string</CheckAccountType>
  <CheckType>string</CheckType>
  <CheckNameOn>string</CheckNameOn>
  <CheckRoutingNum>string</CheckRoutingNum>
  <CustomerCity>string</CustomerCity>
  <CustomerCountry>string</CustomerCountry>
  <CustomerID>string</CustomerID>
  <CustomerName>string</CustomerName>
  <CustomerEmail>string</CustomerEmail>
  <CustomerFirstName>string</CustomerFirstName>
  <CustomerLastName>string</CustomerLastName>
  <CustomerProvince>string</CustomerProvince>
  <CustomerState>string</CustomerState>
  <CustomerStreetAddress1>string</CustomerStreetAddress1>
  <CustomerStreetAddress2>string</CustomerStreetAddress2>
  <CustomerStreetAddress3>string</CustomerStreetAddress3>
  <CustomerZip>string</CustomerZip>
  <CustomerStatus>string</CustomerStatus>
  <CustomerKey>string</CustomerKey>
</BillingDataResult>