GetCheckToken

This Web service tokenizes provided ACH account information using the a ClientSessionID gathered from the GetClientSession Web service and returns the token as a CheckInfoKey. The URL to access this Web service is:

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

Descriptions of the parameters are listed below:

Parameter

Value

ClientSessionID

Required: ClientSessionID value generated by GetClientSession Web service

CkAccountNum

Required: Check account number to tokenize

CkTransitNum

Required: Check transit/routing number to tokenize

CkNameOnAccount

Optional: Name associated with the account

CheckType

Optional: Type of check. Valid values are: Personal, Corporate, or Government

AccountType

Optional: Bank account type for the check. Valid values are Checking or Savings. At the moment, the default value is Checking, but it is a best practice to explicitly pass a value of ‘Checking’ instead of relying on this default, which may change

CkStreet

Optional: Account holder’s billing address street

CcZip

Optional: Account holder’s billing address ZIP code

FirstName

Optional: Account holder’s First Name for the customer profile

LastName

Optional: Account holder’s Last Name for the customer profile

Example

The following table contains sample data you can use to test this Web service. The ClientSessionID must be generated via the GetClientSession Web service on a per session basis, so the value below should be changed when testing this example.

Parameter 

Value

ClientSessionID

e6812d7a-b748-445a-bc71-2edfe56c2138

CkAccountNum

 123456790

CkTransitNum

 125000024

CkNameOnAccount

 John Smith

CheckType

Personal

AccountType

 Checking

CkStreet

123 Test Street

CcZIp

20191

FirstName

FName

LastName

LName

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

<CustomerID>6865-JohnSmith-20200710165151</CustomerID>

<ClientSessionID>e6812d7a-b748-445a-bc71-2edfe56c2138</ClientSessionID>

<CustomerKey>1102343</CustomerKey>

<CheckInfoKey>36612</CheckInfoKey>

<code>OK</code>

<error>CheckInfoKey generated successfully</error>

<Partner>102</Partner>

<Username>vwrs3582</Username>

</RecurringResult>