SmartPayments Web Service

SmartPayments

Click here for a complete list of operations.

ProcessCheck

Process ePayment Check Transactions. Valid input values are: UserName & Password - Assigned by the payment gateway, TransType - Auth | Sale | RepeatSale | Return | Force | Void | Capture | CaptureAll, CheckNum - Check Number, TransitNum - Transit NUmber AccountNum - AccountNumber, Amount - Amount in DDDDD.CC format, MICR - MICR, NameOnCheck - NameOnCheck, DL - Drivers License, SS - Social Security, StateCode - State Code of the Driver License, CheckType - CheckType (Personal | Corporate | Government), ExtData - Extended Data in XML, Valid Values are: Timeout - Timeout Value in Seconds (default=40), PNRef - Reference Number Assigned by the payment gateway, Phone - Phone Number, EMail - E-Mail Address, RawMICR - Check RawMICR Data, InvNum - Invoice Number, TrainingMode - Training Mode T or F, AccountType - Account Type (Saving | Checking), CityOfAccount - City where the bank account is located, BillToStreet - Street address of the billing address, BillToCity - City of the billing address, BillToState - State/Province of the billing address, BillToPostalCode - Zip/Postal Code of the billing address, BillToCountry - Country of the billing address, ACH_Payment_Type - ARC |CCD | POP | PPD | RCK | TEL | WEB

Test

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

Parameter	Value
UserName:
Password:
TransType:
CheckNum:
TransitNum:
AccountNum:
Amount:
MICR:
NameOnCheck:
DL:
SS:
DOB:
StateCode:
CheckType:
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 /ArgoFire/transact.asmx HTTP/1.1
Host: secure.ftipgw.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://TPISoft.com/SmartPayments/ProcessCheck"

<?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>
    <ProcessCheck xmlns="http://TPISoft.com/SmartPayments/">
      <UserName>string</UserName>
      <Password>string</Password>
      <TransType>string</TransType>
      <CheckNum>string</CheckNum>
      <TransitNum>string</TransitNum>
      <AccountNum>string</AccountNum>
      <Amount>string</Amount>
      <MICR>string</MICR>
      <NameOnCheck>string</NameOnCheck>
      <DL>string</DL>
      <SS>string</SS>
      <DOB>string</DOB>
      <StateCode>string</StateCode>
      <CheckType>string</CheckType>
      <ExtData>string</ExtData>
    </ProcessCheck>
  </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>
    <ProcessCheckResponse xmlns="http://TPISoft.com/SmartPayments/">
      <ProcessCheckResult>
        <Result>int</Result>
        <RespMSG>string</RespMSG>
        <Message>string</Message>
        <Message1>string</Message1>
        <Message2>string</Message2>
        <AuthCode>string</AuthCode>
        <PNRef>string</PNRef>
        <HostCode>string</HostCode>
        <HostURL>string</HostURL>
        <ReceiptURL>string</ReceiptURL>
        <GetAVSResult>string</GetAVSResult>
        <GetAVSResultTXT>string</GetAVSResultTXT>
        <GetStreetMatchTXT>string</GetStreetMatchTXT>
        <GetZipMatchTXT>string</GetZipMatchTXT>
        <GetCVResult>string</GetCVResult>
        <GetCVResultTXT>string</GetCVResultTXT>
        <GetGetOrigResult>string</GetGetOrigResult>
        <GetCommercialCard>string</GetCommercialCard>
        <WorkingKey>string</WorkingKey>
        <KeyPointer>string</KeyPointer>
        <ExtData>string</ExtData>
      </ProcessCheckResult>
    </ProcessCheckResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ArgoFire/transact.asmx HTTP/1.1
Host: secure.ftipgw.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ProcessCheck xmlns="http://TPISoft.com/SmartPayments/">
      <UserName>string</UserName>
      <Password>string</Password>
      <TransType>string</TransType>
      <CheckNum>string</CheckNum>
      <TransitNum>string</TransitNum>
      <AccountNum>string</AccountNum>
      <Amount>string</Amount>
      <MICR>string</MICR>
      <NameOnCheck>string</NameOnCheck>
      <DL>string</DL>
      <SS>string</SS>
      <DOB>string</DOB>
      <StateCode>string</StateCode>
      <CheckType>string</CheckType>
      <ExtData>string</ExtData>
    </ProcessCheck>
  </soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ProcessCheckResponse xmlns="http://TPISoft.com/SmartPayments/">
      <ProcessCheckResult>
        <Result>int</Result>
        <RespMSG>string</RespMSG>
        <Message>string</Message>
        <Message1>string</Message1>
        <Message2>string</Message2>
        <AuthCode>string</AuthCode>
        <PNRef>string</PNRef>
        <HostCode>string</HostCode>
        <HostURL>string</HostURL>
        <ReceiptURL>string</ReceiptURL>
        <GetAVSResult>string</GetAVSResult>
        <GetAVSResultTXT>string</GetAVSResultTXT>
        <GetStreetMatchTXT>string</GetStreetMatchTXT>
        <GetZipMatchTXT>string</GetZipMatchTXT>
        <GetCVResult>string</GetCVResult>
        <GetCVResultTXT>string</GetCVResultTXT>
        <GetGetOrigResult>string</GetGetOrigResult>
        <GetCommercialCard>string</GetCommercialCard>
        <WorkingKey>string</WorkingKey>
        <KeyPointer>string</KeyPointer>
        <ExtData>string</ExtData>
      </ProcessCheckResult>
    </ProcessCheckResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /ArgoFire/transact.asmx/ProcessCheck?UserName=string&Password=string&TransType=string&CheckNum=string&TransitNum=string&AccountNum=string&Amount=string&MICR=string&NameOnCheck=string&DL=string&SS=string&DOB=string&StateCode=string&CheckType=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"?>
<Response xmlns="http://TPISoft.com/SmartPayments/">
  <Result>int</Result>
  <RespMSG>string</RespMSG>
  <Message>string</Message>
  <Message1>string</Message1>
  <Message2>string</Message2>
  <AuthCode>string</AuthCode>
  <PNRef>string</PNRef>
  <HostCode>string</HostCode>
  <HostURL>string</HostURL>
  <ReceiptURL>string</ReceiptURL>
  <GetAVSResult>string</GetAVSResult>
  <GetAVSResultTXT>string</GetAVSResultTXT>
  <GetStreetMatchTXT>string</GetStreetMatchTXT>
  <GetZipMatchTXT>string</GetZipMatchTXT>
  <GetCVResult>string</GetCVResult>
  <GetCVResultTXT>string</GetCVResultTXT>
  <GetGetOrigResult>string</GetGetOrigResult>
  <GetCommercialCard>string</GetCommercialCard>
  <WorkingKey>string</WorkingKey>
  <KeyPointer>string</KeyPointer>
  <ExtData>string</ExtData>
</Response>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /ArgoFire/transact.asmx/ProcessCheck HTTP/1.1
Host: secure.ftipgw.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

UserName=string&Password=string&TransType=string&CheckNum=string&TransitNum=string&AccountNum=string&Amount=string&MICR=string&NameOnCheck=string&DL=string&SS=string&DOB=string&StateCode=string&CheckType=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"?>
<Response xmlns="http://TPISoft.com/SmartPayments/">
  <Result>int</Result>
  <RespMSG>string</RespMSG>
  <Message>string</Message>
  <Message1>string</Message1>
  <Message2>string</Message2>
  <AuthCode>string</AuthCode>
  <PNRef>string</PNRef>
  <HostCode>string</HostCode>
  <HostURL>string</HostURL>
  <ReceiptURL>string</ReceiptURL>
  <GetAVSResult>string</GetAVSResult>
  <GetAVSResultTXT>string</GetAVSResultTXT>
  <GetStreetMatchTXT>string</GetStreetMatchTXT>
  <GetZipMatchTXT>string</GetZipMatchTXT>
  <GetCVResult>string</GetCVResult>
  <GetCVResultTXT>string</GetCVResultTXT>
  <GetGetOrigResult>string</GetGetOrigResult>
  <GetCommercialCard>string</GetCommercialCard>
  <WorkingKey>string</WorkingKey>
  <KeyPointer>string</KeyPointer>
  <ExtData>string</ExtData>
</Response>