Introduction

Visit us at: http://www.hypercom.com.

Copyright 2001-07 Hypercom Payment Solutions, a division of Hypercom USA. All Rights Reserved

Congratulations on the selection of Payment Server Software Development Kit (SDK) Payment Processing Software, the most advanced solution in the industry for processing credit cards, debit cards and check services. This software provides you with a fast, easy, reliable way to authorize credit card, ATM/debit card, and check transactions on your PC. This guide prepares you with the detailed information that you will need to install, configure and test your payment processing application. Your opinion is important to us. If you have any suggestions feel free to email us. Thank you for choosing Hypercom! Hypercom Corporation 2851 W. Kathleen Road Phoenix, Arizona 85053 Email: [email protected] Phone: 425-882-0296

Support
TPI Software is committed to providing the highest quality tools and customer support. If you have any questions, comments or suggestions please contact TPI Software by: Email: [email protected] Phone: 425-882-0296

License Information
DISCLAIMER
The SmartPayments and supporting services are licensed on an as is basis. There are no warranties, expressed or implied, including, but not limited to, warranties of merchantability or of fitness for a particular purpose, and all such warranties are expressly and specifically disclaimed. TPI Software shall have no liability or responsibility to you nor any other person or entity with respect to any liability, loss, or damage caused or alleged to be caused directly or indirectly by any SmartPayments software and supporting services. Use of the SmartPayments software and supporting services signifies agreement with this disclaimer and is subject to the license agreement provided with the installation of the software.

LICENSE
Use of the SmartPayments services requires a signed service agreement by the end user of the service or reseller of such services. TPI Software grants you the right to use this software and supporting software for the purpose of connecting to the TPI payment gateway or your processor, on any device of choice. You may physically transfer each license, without cost, to a different computer.

RESTRICTED USE
Copying of the manual, interface specifications, or system files for use other than backing up files and/or to connect to systems other than the TPI payment gateway or your processor is prohibited. You may not remove any product identification, copyright, or other proprietary notices from the software or documentation. Reverse engineering is strictly prohibited. This client software is provided for use in connecting with the TPI payment system gateway or your processor only. Use of any components, code, or documentation to connect to other systems is strictly prohibited and a violation of this agreement and subject to all remedies available by law.

EULA
END-USER LICENSE AGREEMENT FOR SMARTPAYMENTS SOFTWARE IMPORTANT READ CAREFULLY: This Hypercom End-User License Agreement ( EULA ) is a legal agreement between you (either an individual or a single entity) and Hypercom for the Hypercom product accompanying this EULA, which includes computer software and may include associated media, printed materials, and online or electronic documentation (SOFTWARE). By installing, copying, or otherwise using the SOFTWARE, you agree to be bound by the terms of this EULA. If you do not agree to the terms of this EULA, do not install, copy, or otherwise use the SOFTWARE.

SOFTWARE PRODUCT LICENSE Hypercom Software (SOFTWARE) is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. The SOFTWARE is licensed, not sold. GRANT OF LICENSE Hypercom Payment Solutions, a division of Hypercom USA, hereby grants you ("Licensee") a limited, nonexclusive, non-transferable, royalty-free license to make and use a single copy an unlimited number of copies of the SOFTWARE accompanying this EULA to be installed on CPUs residing on Licensee's premises, solely for Licensee's internal use. Hypercom and its suppliers shall retain title and all ownership rights to the product, and this Agreement shall not be construed in any manner as transferring any rights of ownership or license to the SOFTWARE or to the features or information therein, except as specifically stated herein.

USE RESTRICTION Licensee acknowledges that the SOFTWARE acquired hereunder can only be used for reseller and/or end merchant evaluation and/or products intended use of payment processing. Use of this product for any other purposes such as Competitor Evaluation, Reverse Engineering, Decompilation, and Disassembly is violation of this License and Licensee agrees that such acts are a blatant and flagrant violation of this License and will be subject to any and all penalties and remedies available by Law for violation of intellectual property laws and treaties.

DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS

(a) Limitations on Modification, Reverse Engineering, Decompilation, and Disassembly. Licensee may not modify, reverse engineer, decompile, or disassemble the SOFTWARE, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation. (b) No Rights to Sublicense or Rental. License may not rent, lease or lend the SOFTWARE. (c) Termination. Without prejudice to any other rights, Hypercom may terminate this EULA if Licensee fails to comply with the terms and conditions of this EULA. In such event, Licensee must destroy all copies of the SOFTWARE and all of its component parts. (d) Reservation of Rights. Licensee agrees that the SOFTWARE is owned Hypercom and all rights not expressly granted herein are reserved by Hypercom.

PRODUCT MAINTENANCE Licensee understands and agrees that Hypercom may provide updates to the SOFTWARE from time to time but Hypercom shall have no obligation to provide maintenance or updates to Licensee for SOFTWARE licensed under this Agreement.

CONFIDENTIALITY (a) Licensee understands that the SOFTWARE contains confidential and proprietary trade secret information of Hypercom that are not commercially available to the public. The Licensee agrees that, in partial consideration for Hypercoms allowing Licensee access to and use of the SOFTWARE pursuant to this EULA: (i) Licensee shall treat the SOFTWARE in the same manner that it treats its most confidential and proprietary trade secret materials, and (ii) Licensee shall take all measures necessary to prevent the SOFTWARE from falling into the possession of persons not bound to maintain the confidentiality of the trade secrets contained within the SOFTWARE. As such, Licensee shall only permit employees and contractors who have a need to use the SOFTWARE for the purposes stated in the license grant (Section 1) to have access to and use such SOFTWARE, and Licensees contractors shall not use the SOFTWARE unless and until they have entered into written non-disclosure agreements with the Licensee that require them to maintain the confidentiality of SOFTWARE. Licensee shall promptly advise Hypercom, in writing, of any misappropriation or misuse of the SOFTWARE by any person which may come to the Licensees attention. (b) Licensee understands and agrees that disclosure or use of the SOFTWARE except as authorized above will result in irreparable harm to Hypercom and that monetary damages may be inadequate to compensate Hypercom for such breach. Accordingly, the Licensee

agrees that Hypercom will, in addition to any other remedies available to it at law or in equity, be entitled to injunctive relief to enforce the terms of this Agreement.

COPYRIGHT All title and copyrights in and to the SOFTWARE (including but not limited to any images, photographs, animations, video, audio, music, text, and applets incorporated into the SOFTWARE), the accompanying printed materials, and any copies of the SOFTWARE are owned by Hypercom or its suppliers. The SOFTWARE is protected by copyright laws and international treaty provisions. Therefore, Licensee must treat the SOFTWARE PRODUCT like any other copyrighted material except that Licensee may install the SOFTWARE on a single computer provided Licensee keep the original solely for backup or archival purposes. License may not copy any printed materials accompanying the SOFTWARE without prior permission of Hypercom.

U.S. GOVERNMENT RESTRICTED RIGHTS The SOFTWARE and documentation are provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c)(1) and (2) of the Commercial Computer Software Restricted Rights at 48 CFR 52.227-19, as applicable. Manufacturer is Hypercom Payment Solutions, a division of Hypercom USA./2851 W. Kathleen Road/Phoenix, Arizona 85053. EXPORT RESTRICTIONS Licensee acknowledges that the SOFTWARE acquired hereunder are subject to the export control laws and regulations of the U.S.A., and any amendments thereof. Licensee confirms that with respect to these SOFTWARE, it will not export or re-export them, directly or indirectly, either to (i) any countries that are subject to U.S.A export restrictions (currently including, but not necessarily limited to, Cuba, the Federal Republic of Yugoslavia (Serbia and Montenegro), Iran, Iraq, Libya, North Korea, South Africa (military and police entities), Syria, and Vietnam); (ii) any end user who Licensee knows or has reason to know will utilize them in the design, development or production of nuclear, chemical or biological weapons; or (iii) any end user who has been prohibited from participating in the U.S.A. export transactions by any federal agency of the U.S.A. government. Licensee further acknowledges that the SOFTWARE may include technical data subject to export and re-export restrictions imposed by U.S.A. law.

DISCLAIMER OF WARRANTY

THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, TPI FURTHER DISCLAIMS ALL WARRANTIES, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. THE ENTIRE RISK ARISING OUT OF THE USE OR PERFORMANCE OF THE PRODUCT AND DOCUMENTATION REMAINS WITH LICENSEE. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL HYPERCOM BE LIABLE FOR ANY CONSEQUENTIAL, INCIDENTAL, DIRECT, INDIRECT, SPECIAL, PUNITIVE, OR OTHER DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THE PRODUCT OR DOCUMENTATION, EVEN IF HYPERCOM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME STATES/JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITATION MAY NOT APPLY TO LICENSEE.

GOVERNING LAW This EULA shall be governed by the laws of the State of Washington. Should you have any questions concerning this EULA, or if you desire to contact Hypercom for any reason, please write: Hypercom Payment Solutions, a division of Hypercom USA./2851 W. Kathleen Road/Phoenix, Arizona 85053.

Overview
Testing
You can request a test account on our server to be established at our demo host server. To request this account, please send your email request to our technical support staff. Please include the following information with your test account request: company name, your name, phone number, email address associated with the test account, and which payment processor you would like to test. An email response will be sent with valid test information. Testing can be performed with the following test cards:
Card Type MasterCard Visa Number 5000300020003003 4005550000000019

Discover Diners AMEX

60011111111111117 36999999999999 374255312721002

Web Services
ePayment Web Services
The following operations are supported. GetCardTrx Retrieves card transaction details for a merchant GetCardTrxSummary Retrieves card transaction summary for a merchant GetCheckTrx Retrieves check transaction details for a merchant GetCardType Returns the name of the card issuer; such as Visa, MasterCard, AMEX, etc. GetInfo Retrieves information from the web service GetOpenBatchSummary Retrieves payment type transaction summary of the current open batch for a merchant IsCommercialCard Returns (T/F) if the card is a known commercial card ProcessCheck Processes check transactions for a merchant ProcessCreditCard Processes credit card transactions for a merchant ProcessDebitCard Processes debit card transactions for a merchant ProcessEBTCard Processes EBT card transactions for a merchant ProcessGiftCard Processes gift card transactions for a merchant ProcessSignature Sends a signature to apply to a receipt transaction ValidCard Validates the credit card by checking the card length based on the card type, performing a mod 10 checksum, and validating the expiration date ValidCardLength Validates the credit card length VaildExpDate Validates the expiration date of the credit card ValidMod10 Validates the credit card by performing a mod 10 checksum on the card number; returns (T/F) AddMerchant Adds a merchant to the account DeleteMerchant Deletes a merchant from the account AddRecurringCreditCard -Allows customer information to be programmatically stored through web services for recurring billing.

AddRecurringCheck- Allows check information to be programmatically stored through web services for recurring billing. *ProcessCreditCard -Allows for processing credit card transactions in recurring billing . *ProcessCheck- Allows for processing ACH /check transactions for recurring billing. ManageCheckInfo Allows for programmatic management of existing check information for recurring billing. ManageCreditCardInfo- Allows for programmatic management of credit card information for customers specific to recurring billing. ManageContract Allows for managing exisiting contracts for updates and modifications. ManageCustomer Allows for management of existing customers in the recurring billing web service. ManageContractAddDaysToNextBillDt Allows for modification of next billing date for recurring billing contracts. GetNetworkID- This web service allows for returning the debit network ID if the debit card number matches any of these networks bin ranges

* = This is for recurring.asmx webservice. Not to be confused with Transact.asmx

GetCardTrx
This Web service operation retrieves card transaction details for a merchant. The URL to access this Web service is: https://localhost/admin/ws/trxdetail.asmx?op=GetCardTrx. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password RPNum Description Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. The merchant's RP Number in order to uniquely identify merchant's account for the query Optional. The unique payment reference number assigned to the transaction. If this field is provided, all other query fields will be ignored when using PNRef parameter to query the system. Required, except when PNRef is provided. The begin date of the date range in MM/DD/YYYY (or YYYY-MM-DD or YYYY-MM-DDThh:mm:ss) format. This date will be converted to YYYY-MM-DDThh:mm:ss (time is in

PNRef

BeginDt

24-hour format). If the passed-in BeginDt does not contain time information, BeginDt will default to midnight on the given date. For example: 2005-08-19T12:00:12 is kept as is 2005-08-19 becomes 2005-08-19T00:00:00 2005/08/19 becomes 2005-08-19T00:00:00 08/19/2005 becomes 2005-08-19T00:00:00 The query to obtain transactions in the date range is constructed as follows: (Date DT >=BeginDt) AND (Date DT<EndDt) where Date DT is the transaction timestamp Required, except when PNRef is provided. The end date of the date range in MM/DD/YYYY (or YYYY-MM-DD or YYYY-MM-DDThh:mm:ss) format. This date will be converted to YYYY-MM-DDThh:mm:ss (time is in 24-hour format). If the passed-in EndDt does not contain time information, EndDt will be incremented to the next day at midnight such that no transaction on the desired end date will be excluded based on its time. For example: 2005-08-19T12:00:12 is kept as is 2005-08-19 becomes 2005-08-20T00:00:00 08/19/2005 becomes 2005-08-20T00:00:00 Optional. If provided, only those transactions matching the PaymentType will be included. Valid values are:

EndDt

PaymentType

'AMEX' American Express card 'CARTBLANCH' Carte Blanch card 'DEBIT' Debit card 'DINERS' Diners Club card 'DISCOVER' Novus Discover card 'EBT' Electronic Benefit Transfer 'JAL' JAL card 'JCB' Japanese Commercial Bank card 'MASTERCARD' Master card 'VISA' Visa card EGC Gift card 'PAYRECEIPT' to retrieve receipt images that were uploaded to the payment server 'SETTLE' to retrieve requests to settle transactions

Or any permutation of the above values, e.g. "'PAYRECEIPT','SETTLE'" will pull all transactions with either PayReceipt or Settle payment types. ExcludePaymentType Optional. If provided, any transaction matching the ExcludePaymentType will be excluded Optional. If provided, only those transactions matching the TransType will be included. Valid values are TransType

'Authorization' to retrieve previously-authorized (pre-auth) transactions

'Capture' to retrieve captured transactions 'Credit' to retrieve return transactions 'ForceCapture' to retrieve force-auth transactions 'GetStatus' to make an inquiry to the EBT or gift cards balance 'PostAuth' to retrieve post-auth transactions 'Purged' to remove a transaction from the current batch due to an error 'Receipt' to retrieve receipt images that were uploaded to the payment server 'RepeatSale' to retrieve repeat-sale transactions 'Sale' to retrieve sale transactions 'Void' to retrieve void transactions

Or any permutation of the above values, e.g. "'Credit','Sale'" will pull all transactions with either Credit or Sale transaction types. ExcludeTransType ApprovalCode Optional. If provided, any transaction matching the ExcludeTransType will be excluded Optional. If provided, only those transactions matching the ApprovalCode parameter will be included Optional. If provided, only those transactions matching the Result will be included. Valid values are: Result

0 is Approved Anything else is declined; if you want all the declined transactions, you should leave this field empty and use the ExcludeResult=0 instead.

ExcludeResult

Optional. If provided, any transactions matching the ExcludeResult will be excluded. Optional. Cardholders name as it is appears on the card. If provided, only those transactions with cardholders name matching NameOnCard will be included. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234" Optional. A card number. If provided, only those transactions with the cardholder's name matching CardNum will be included. Matching is done using wild cards Optional. If provided, only those transactions matching the CardType will be included. Valid values are:

NameOnCard

CardNum

CardType

'AMEX' American Express card 'CARTBLANCH' Carte Blanch card 'DEBIT' Debit card 'DINERS' Diners Club card

'DISCOVER' Novus Discover card 'EBT' Electronic Benefit Transfer 'JAL' JAL card 'JCB' Japanese Commercial Bank card 'MASTERCARD' Master card 'VISA' Visa card EGC Gift card

Or any permutation of the above values, "'VISA','MASTER','DISCOVER'" will pull all transactions with either VISA, MASTER and DISCOVER card type ExcludeCardType ExcludeVoid Optional. If provided, any transaction matching the ExcludeCardType will be excluded Required, except when PNRef is provided. An option to exclude voided transactions or not; must either be TRUE or FALSE Optional. The user who originated the transactions. If provided, only those transactions created by the matching User will be included. Matching is done using wild cards Optional. The invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included. Matching is done using wild cards Optional. An option to retrieve the settled transactions or unsettled transactions; must either be 1 for true or 0 for false Optional. The settlement ID or message returned from the host Optional. The date of the settlement Optional. The type of format to transform the data into. Leave the field blank to default to XML TransformType

User

InvoiceId

SettleFlag SettleMsg SettleDt

XML will output the plain XML string XSL will use XSL to transform the XML output DELIM uses ColDelim and RowDelim to format the output

Xsl

Optional. This field is used only if the TransformType is XSL. The XSL to transform the resulting dataset. If provided, the resulting dataset will be transformed using this XSL. You may pass in a URL to the XSL file, or the XSL string itself. If this field is not empty, the Web Services will try to locate the file from the URL. If that also fails, it will treat it as an XSL string. In any case, the final XSL string will be loaded and validated against the XSL schema; if it passes, then that XSL will be used for transformation. A sample predefined XSL is included with this Web Services:

ColDelim

http://localhost/admin/ws/TabDelim.xsl for a tab delimited transformation

Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each column

RowDelim

Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each row Optional. This field is used only if the TransformType is DELIM. If TRUE, then field headers will be included in the first row using the same delimiter strings; must either be TRUE or FALSE Optional. Extended data in XML format. Valid values are:

IncludeHeader

ExtData

<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE> for no image <IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE> for only the image <IMAGE_TYPE>ALL</IMAGE_TYPE> for all images <CustomerID>CustomerID<CustomerID> for customer ID <Amount>Amount</Amount> Total amount to search transactions for in DDDD.CC format. <RegisterNum>RegisterNum</RegisterNum> Register number, originally passed with the transaction, to search transactions for.

Example
The following table contains sample data you can use to test this Web service. The UserName, Password, and RPNum parameters should be changed when testing this example yourself. The example data shown will create a list of sale card transactions that were processed between 1/1/2000 and 1/1/3000. The format of the output will show descriptive headers and will be similar to a Comma Separate Values (CSV) format because of the use of the "," character as the column delimiter.
Parameter UserName Password RPNum BeginDt EndDt TransType ExcludeVoid TransformType ColDelim RowDelim IncludeHeader Value test 123 1 1/1/2000 1/1/3000 'Sale' TRUE DELIM , | TRUE

Result: The following is the result of the using the Web Services with the sample data from the table above.
<?xml version="1.0" encoding="utf-8" ?> <string xmlns="http://localhost/admin/ws "> TRX_HD_Key,Invoice_ID,Seq_Num_CH,Date_DT,Merchant_Key,User_Name _VC,Register_Number_CH,Reseller_Key,Payment_Type_ID,Trans_Type_ID, Processor_ID,TRX_Settle_Key,TRX_Settle_Msg_VC,Void_Flag_CH,Settle_Fla g_CH,Ref_Number_CH,Settle_Date_DT,Last_Update_DT,TRX_Card_Key,Card _Info_Key,Auth_Amt_MN,Tip_Amt_MN,Total_Amt_MN,Cash_Back_Amt_MN, SureCharge_Amt_MN,Account_Type_CH,Result_CH,Result_Txt_VC,Approval _Code_CH,Host_Ref_Num_CH,AVS_Resp_CH,AVS_Resp_Txt_VC,CV_Resp_C H,CV_Resp_Txt_VC,Host_Date_CH,Host_Time_CH,Acct_Num_CH,Exp_CH,Ty pe_CH,Name_on_Card_VC,Street_CH,Zip_CH,Track_VC,Pin_Block_CH,TRX_ Receipt_key,Create_Date_DT,Receipt_Type_ID,IP_VC|14,,,12/3/2003 10:47:48 AM,1,test , ,100,VISA ,Sale ,VITAL ,14,GB00004 ACCEPTED,,1,,12/3/2003 10:46:34 AM,12/3/2003 10:48:13 AM,14,14,2.5000,0,2.5000,0,0,VISA ,0 ,APPROVAL VITAL1 ,VITAL1 , ,0,, ,,,,4266503700000247,1009 ,VISA ,VINCE VISA , , ,1, ,,,,127.0.0.1|13,,,12/3/2003 10:04:29 AM,1,test , ,100,MASTERCARD,Sale ,VITAL ,13,GB00004 ACCEPTED,,1,,12/3/2003 10:46:34 AM,12/3/2003 10:48:13 AM,13,13,2.8500,0,2.8500,0,0,MASTERCARD,0 ,APPROVAL VITAL9 ,VITAL9 , ,0,, ,,,,5424000000000015,0905 ,MASTERCARD, , , ,, ,,,,127.0.0.1|12,,,12/3/2003 9:45:59 AM,1,test , ,100,VISA ,Sale ,VITAL ,12,GB00003 ACCEPTED,,1,,12/3/2003 9:46:16 AM,12/3/2003 9:46:16 AM,12,12,1.6800,0,1.6800,0,0,VISA ,0 ,APPROVAL VITAL3 ,VITAL3 , ,0,, ,,,,4126196901499,0905 ,VISA , , , ,, ,,,,127.0.0.1|10,,,12/3/2003 9:35:19 AM,1,test , ,100,VISA ,Sale ,VITAL ,10,GB00003 ACCEPTED,,1,,12/3/2003 9:46:16 AM,12/3/2003 9:46:16 AM,10,10,2.3500,0,2.3500,0,0,VISA ,0 ,APPROVAL VITAL8 ,VITAL8 , ,0,, ,,,,4055016727870315,0905 ,VISA , , , ,, ,,,,127.0.0.1|7,,,12/3/2003 9:27:57 AM,1,test , ,100,VISA ,Sale ,VITAL ,7,GB00002 ACCEPTED,,1,,12/3/2003 9:26:35 AM,12/3/2003 9:28:16 AM,7,7,1.2500,0,1.2500,0,0,VISA ,0 ,APPROVAL VITAL4 ,VITAL4 , ,0,, ,,,,4007000000027,0905 ,VISA , , , ,, ,,,,127.0.0.1|6,,,12/3/2003 9:27:44 AM,1,test , ,100,VISA ,Sale ,VITAL ,6,GB00002 ACCEPTED,,1,,12/3/2003 9:26:35 AM,12/3/2003 9:28:16 AM,6,6,2.0000,0,2.0000,0,0,VISA ,0 ,APPROVAL VITAL9 ,VITAL9 , ,0,, ,,,,4007000000027,0905 ,VISA , , , ,, ,,,,127.0.0.1|5,,,12/3/2003 9:27:15 AM,1,test , ,100,MASTERCARD,Sale ,VITAL ,5,,,,,,12/3/2003 9:27:17 AM,5,5,1.2500,0,1.2500,0,0,MASTERCARD,12 , ACCT LENGTH ERR,EA , ,0,, ,,,,5405001478615777532,0905 ,MASTERCARD, , , ,, ,,,,127.0.0.1|2,,,12/3/2003 9:03:16 AM,1,test , ,100,MASTERCARD,Sale ,VITAL ,2,GB00001 ACCEPTED,,1,,12/3/2003 9:03:40 AM,12/3/2003 9:03:40 AM,2,2,2.4500,0,2.4500,0,0,MASTERCARD,0 ,APPROVAL VITAL7 ,VITAL7 , ,0,, ,,,,5424000000000015,0905 ,MASTERCARD, , , ,, ,,,,127.0.0.1|1,,,12/3/2003 8:58:02 AM,1,test , ,100,VISA ,Sale ,VITAL ,1,GB00001 ACCEPTED,,1,,12/3/2003 9:03:40 AM,12/3/2003 9:03:40 AM,1,1,1.0000,0,1.0000,0,0,VISA ,0 ,APPROVAL VITAL3 ,VITAL3 , ,0,, ,,,,4111111111111111,0905 ,VISA , , , ,, ,,,,127.0.0.1 </string>

GetCardTrxSummary
This Web service operation retrieves a card transaction summary for a merchant. The URL to access this Web service is: https://localhost/admin/ws/trxdetail.asmx?op=GetCardTrxSummary. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password RPNum BeginDt EndDt ApprovalCode Register Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. The merchant's RP Number in order to uniquely identify the merchant's account for the query Required. The begin date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT00:00:00:0000AM Required. The end date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT12:59:59:9999PM Optional. If provided, only those transactions matching the ApprovalCode parameter will be included Optional. The register that originated the transaction. If provided, only those transactions with the matching register will be included Optional. Cardholders name as it is appears on the card. If provided, only those transactions with cardholders name matching NameOnCard will be included. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234" Optional. A card number. If provided, only those transactions with the cardholder's name matching CardNum will be included. Matching is done using wild cards Optional. If provided, only those transactions matching the CardType will be included. Valid values are:

NameOnCard

CardNum

CardType

'AMEX' American Express card 'CARTBLANCH' Carte Blanch card 'DEBIT' Debit card 'DINERS' Diners Club card 'DISCOVER' Novus Discover card 'EBT' Electronic Benefit Transfer 'JAL' JAL card 'JCB' Japanese Commercial Bank card 'MASTERCARD' Master card 'VISA' Visa card 'EGC' Gift card

ExcludeVoid

Required. Whether to exclude voided transactions; must either be TRUE or FALSE. Default is TRUE Optional. The user who originated the transactions. If provided, only those transactions created by the matching User will be included. Matching is done using wild cards Optional. An option to retrieve the settled transactions or unsettled transactions; must either be TRUE or FALSE Optional. The settlement ID or message returned from the host Optional. The settlement timestamp Optional. The type of format to transform the data into. Leave the field blank to default to XML

User

SettleFlag SettleMsg SettleDt

TransformType

XML will output the plain XML string XSL will use XSL to transform the XML output DELIM uses ColDelim and RowDelim to format the output

Xsl

Optional. This field is used only if the TransformType is XSL. The XSL to transform the resulting dataset; if provided, the resulting dataset will be transformed using this XSL. You may pass in a URL to the XSL file, or the XSL string itself. If this field is not empty, the Web Services will try to locate the file from the URL. If that also fails, it will treat it as a XSL string. In any case, the final XSL string will be loaded and validated against the XSL schema; if it passes, then that XSL will be used for transformation. A sample predefined XSL is included with this Web Services:

ColDelim RowDelim

http://localhost/admin/ws/TabDelim.xsl for a tab delimited transformation

Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each column Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each row Optional. This field is used only if the TransformType is DELIM. If TRUE, then field headers will be included in the first row using the same delimiter strings; must either be TRUE or FALSE Optional. Extended data in XML format. Valid values are:

IncludeHeader

ExtData

<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE> for no image <IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE> for only the image <IMAGE_TYPE>ALL</IMAGE_TYPE> for all images

Example
The following table contains sample data you can use to test this Web service. The UserName, Password, and RPNum parameters should be changed when testing this example yourself. The example data shown will create a summarized list of Visa card transactions that were processed between 1/1/2000 and 1/1/3000. The output data is in XML format because the TransformType parameter was not specified.

Parameter UserName Password RPNum BeginDt EndDt CardType ExcludeVoid

Value Test 123 1 1/1/2000 1/1/3000 VISA FALSE

Result:
<?xml version="1.0" encoding="utf-8" ?> <string xmlns="http://localhost/Admin/ws"> <CardTrxSummary> <PaymentMethod> <Payment_Type_ID>VISA </Payment_Type_ID> <Authorization>1.0000</Authorization> <Capture>0</Capture> <ForceCapture>0</ForceCapture> <PostAuth>0</PostAuth> <Return>0</Return> <Sale>2.0000</Sale> <Receipt>0</Receipt> <RepeatSale>0</RepeatSale> <Activate>0</Activate> <Deactivate>0</Deactivate> <Reload>0</Reload> <Authorization_Cnt>1</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt> <PostAuth_Cnt>0</PostAuth_Cnt> <Return_Cnt>0</Return_Cnt> <Sale_Cnt>2</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>0</RepeatSale_Cnt> <Activate_Cnt>0</Activate_Cnt> <Deactivate_Cnt>0</Deactivate_Cnt> <Reload_Cnt>0</Reload_Cnt> <Cnt>3</Cnt> </PaymentMethod> </CardTrxSummary> </string>

GetCheckTrx
This Web service operation retrieves checks transaction details for a merchant. The URL to access this Web service is: https://localhost/admin/ws/trxdetail.asmx?op=GetCheckTrx. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password RPNum Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. The merchant's RP Number in order to uniquely identify merchant's account for the query Optional. The unique payment reference number assigned to the transaction. If this field is provided, all other query fields will be ignored when using PNRef parameter to query the system Required, except when PNRef is provided. The begin date of the date range in MM/DD/YYYY (or YYYY-MM-DD or YYYY-MM-DDThh:mm:ss) format. This date will be converted to YYYY-MM-DDThh:mm:ss (time is in 24-hour format). If the passed-in BeginDt does not contain time information, BeginDt will default to midnight on the given date. For example: 2005-08-19T12:00:12 is kept as is 2005-08-19 becomes 2005-08-19T00:00:00 2005/08/19 becomes 2005-08-19T00:00:00 08/19/2005 becomes 2005-08-19T00:00:00 The query to obtain transactions in the date range is constructed as follows: (Date DT >=BeginDt) AND (Date DT<EndDt) where Date DT is the transaction timestamp Required, except when PNRef is provided. The end date of the date range in MM/DD/YYYY (or YYYY-MM-DD or YYYY-MM-DDThh:mm:ss) format. This date will be converted to YYYY-MM-DDThh:mm:ss (time is in 24-hour format). If the passed-in EndDt does not contain time information, EndDt will be incremented to the next day at midnight such that no transaction on the desired end date will be excluded based on its time. For example: 2005-08-19T12:00:12 is kept as is 2005-08-19 becomes 2005-08-20T00:00:00 08/19/2005 becomes 2005-08-20T00:00:00 Optional. If provided, only those transactions matching the PaymentType will be included. Valid values are:

PNRef

BeginDt

EndDt

PaymentType

'ACH' Automated Clearing House 'ECHECK' Electronic Check 'GUARANTEE' Guarantee check 'PAYRECEIPT' to retrieve receipt images that were uploaded to the payment server 'SETTLE' to retrieve requests to settle transactions

'VERIFY' to retrieve pre-authorized checks

Or any permutation of the above values, e.g. "'ACH','ECHECK'" will pull all transactions with either ACH or ECHECK payment types ExcludePaymentType Optional. If provided, any transaction matching the ExcludePaymentType will be excluded Optional. If provided, only those transactions matching the TransType will be included. Valid values are:

TransType

'Authorization' to retrieve previously-authorized (pre-auth) transactions 'Capture' to retrieve captured transactions 'Credit' to retrieve return transactions 'ForceCapture' to retrieve force-auth transactions 'GetStatus' to make an inquiry to the EBT or gift cards balance 'PostAuth' to retrieve post-auth transactions 'Purged' to remove a transaction from the current batch due to an error 'Receipt' to retrieve receipt images that were uploaded to the payment server 'RepeatSale' to retrieve repeat-sale transactions 'Sale' to retrieve sale transactions 'Void' to retrieve void transactions

Or any permutation of the above values, e.g. "'Credit','Sale'" will pull all transactions with either Credit or Sale transaction types ExcludeTransType ApprovalCode Optional. If provided, any transaction matching the ExcludeTransType will be excluded Optional. If provided, only those transactions matching the ApprovalCode parameter will be included Optional. If provided, only those transactions matching the Result will be included. Valid values are: Result

0 is Approved Anything else is declined, if you want all the declined transactions, you should leave this field empty and use the ExcludeResult=0 instead

ExcludeResult

Optional. If provided, any transactions matching the ExcludedResult will be excluded Optional. Check owner's name as it is appear on the check, if provided. Only those transactions with check owner's name matching NameOnCheck will be included. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234" Optional. Check number. If provided, only those transactions with

NameOnCheck

CheckNum

matching CheckNum will be included AcctNum Optional. Check account number. If provided, only those transactions matching the AcctNum will be included. Matching is done using wild cards Optional. If provided, any transactions matching the RouteNum (Transit Number) will be excluded. Matching is done using wild cards Optional. Whether to exclude voided transactions; must either be TRUE or FALSE. The default value is TRUE Optional. The user who originated the transactions. If provided, only those transactions created by the matching User will be included. Matching is done using wild cards Optional. The invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included. Matching is done using wild cards Optional. Whether the transaction was settled; must either be 1 for true or 0 for false Optional. The settlement ID or message returned from the host Optional. The settlement timestamp Optional. The type of format to transform the data into. Leave the field blank to default to XML TransformType

RouteNum ExcludeVoid

User

InvoiceId

SettleFlag SettleMsg SettleDt

XML will output the plain XML string XSL will use XSL to transform the XML output DELIM uses ColDelim and RowDelim to format the output

Xsl

Optional. This field is used only if the TransformType is XSL. The XSL to transform the resulting dataset; if provided, the resulting dataset will be transformed using this XSL. You may pass in a URL to the XSL file, or the XSL string itself. If this field is not empty, the Web Services will try to locate the file from the URL. If that also fails, it will treat it as a XSL string. In any case, the final XSL string will be loaded and validated against the XSL schema; if it passes, then that XSL will be used for transformation. A sample predefined XSL is included with this Web Services:

ColDelim RowDelim

http://localhost/admin/ws/TabDelim.xsl for a tab delimited transformation.

Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each column Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each row Optional. This field is used only if the TransformType is DELIM. If TRUE, then field headers will be included in the first row using the same delimiter strings; must either be TRUE or FALSE Optional. Extended data in XML format. Valid values are:

IncludeHeader

ExtData

<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE> for no image

<IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE> for only the image <IMAGE_TYPE>ALL</IMAGE_TYPE> for all images <CustomerID>CustomerID</CustomerID> for customer ID <Amount>Amount</Amount> Total amount to search transactions for in DDDD.CC format. <RegisterNum>RegisterNum</RegisterNum> Register number, originally passed with the transaction, to search transactions for

Example
The following table contains sample data you can use to test this Web service. The UserName, Password, and RPNum parameters should be changed when testing this example yourself. The example data shown will create a list of approved Verify check transactions that were processed between 1/1/2003 and 12/31/2003. The output data is in XML format because the TransformType parameter was not specified.
Parameter UserName Password RPNum BeginDt EndDt PaymentType Result Value Test 123 1 1/1/2003 12/31/2003 'VERIFY' 0

Result:
<?xml version="1.0" encoding="utf-8" ?> <string xmlns=" http://localhost/admin/ws"> <RichDBDS> <TrxDetailCheck> <RichDBDS> <TrxDetailCheck> <TRX_HD_Key>25</TRX_HD_Key> <Invoice_ID /> <Date_DT>2003-1205T13:47:15.1230000-08:00</Date_DT> <Merchant_Key>1</Merchant_Key> <User_Name_VC>test </User_Name_VC> <Register_Number_CH> </Register_Number_CH> <Reseller_Key>100</Reseller_Key> <Payment_Type_ID>VERIFY </Payment_Type_ID> <Trans_Type_ID>Authorization </Trans_Type_ID> <Processor_ID>RMRS </Processor_ID> <Last_Update_DT>2003-1205T13:47:15.1230000-08:00</Last_Update_DT> <TRX_Check_Key>5</TRX_Check_Key> <CheckNum_CH>1001

</CheckNum_CH> <MICR_VC /> <AccountNum_VC>******7890</AccountNum_VC> <TransitNum_VC>123456780</TransitNum_VC> <RawMICR_VC /> <DL_VC /> <SS_CH /> <DOB_CH> </DOB_CH> <StateCode_CH>DE </StateCode_CH> <NameOnCheck_VC>Jane Doe</NameOnCheck_VC> <EMail_VC /> <Phone_VC /> <Amount_MN>1.0000</Amount_MN> <Result_CH>0 </Result_CH> <Result_Txt_VC>&lt;INPUT TYPE=HIDDEN NAME=PARAM_RESPONSE_CODE VALUE="AA"&gt;&lt;INPUT TYPE=HIDDEN NAME=PARAM_AUTH_SOURCE VALUE="0"&gt;&lt;INPUT TYPE=HIDDEN NAME=PARAM_CAP_CODE VALU</Result_Txt_VC> <Host_Approval_CH>963852 </Host_Approval_CH> <Host_Ref_Num_CH> </Host_Ref_Num_CH> <Result_Msg_VC>APPROVAL 963852</Result_Msg_VC> <Result_Msg1_VC /> <Result_Msg2_VC /> <Host_Date_CH>120503 </Host_Date_CH> <Host_Time_CH>164502 </Host_Time_CH> <IP_VC>192.168.2.22</IP_VC> </TrxDetailCheck> <TrxDetailCheck> <TRX_HD_Key>24</TRX_HD_Key> <Invoice_ID /> <Date_DT>2003-12-05T13:46:50.0770000-08:00</Date_DT> <Merchant_Key>1</Merchant_Key> <User_Name_VC>test </User_Name_VC> <Register_Number_CH> </Register_Number_CH> <Reseller_Key>100</Reseller_Key> <Payment_Type_ID>VERIFY </Payment_Type_ID> <Trans_Type_ID>Authorization </Trans_Type_ID> <Processor_ID>RMRS </Processor_ID> <Last_Update_DT>2003-1205T13:46:50.0770000-08:00</Last_Update_DT> <TRX_Check_Key>4</TRX_Check_Key> <CheckNum_CH>4877 </CheckNum_CH> <MICR_VC /> <AccountNum_VC>******7890</AccountNum_VC> <TransitNum_VC>123456780</TransitNum_VC> <RawMICR_VC /> <DL_VC /> <SS_CH /> <DOB_CH> </DOB_CH> <StateCode_CH>WA </StateCode_CH> <NameOnCheck_VC>John Doe</NameOnCheck_VC> <EMail_VC /> <Phone_VC /> <Amount_MN>2.0000</Amount_MN> <Result_CH>0 </Result_CH> <Result_Txt_VC>&lt;INPUT TYPE=HIDDEN NAME=PARAM_RESPONSE_CODE VALUE="AA"&gt;&lt;INPUT TYPE=HIDDEN NAME=PARAM_AUTH_SOURCE VALUE="0"&gt;&lt;INPUT TYPE=HIDDEN NAME=PARAM_CAP_CODE VALU</Result_Txt_VC> <Host_Approval_CH>963852 </Host_Approval_CH> <Host_Ref_Num_CH> </Host_Ref_Num_CH> <Result_Msg_VC>APPROVAL 963852</Result_Msg_VC> <Result_Msg1_VC /> <Result_Msg2_VC /> <Host_Date_CH>120503 </Host_Date_CH> <Host_Time_CH>164437 </Host_Time_CH> <IP_VC>192.168.2.22</IP_VC> </TrxDetailCheck> </RichDBDS> </string>

GetCardType
This Web service operation returns the name of the card issuer, such as Visa, MasterCard, Amex. The URL to access this operation is: https://localhost/SmartPayments/validate.asmx?op=GetCardType. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.

Parameter CardNumber

Description Required. The number of a credit card

Example
The following table contains sample data you can use to test this Web service.
Parameter CardNumber Value 5454545454545454

Result:
<?xml version="1.0" encoding="utf-8" ?> <string xmlns="http://localhost/SmartPayments/">MASTERCARD</string>

GetInfo
This Web service retrieves information pertaining to the transaction type (TransType) specified. The URL to access this Web service is: https://localhost/SmartPayments/transact.asmx?op=GetInfo. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password Description Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. Valid values are:

BatchInquiry returns a comma delimited list in a single XML tag that contains the summarized transaction dollar amount and transaction count for each payment method in the current batch. The list is in the following format: Payment_Method1=0.00, Payment_Method2=0.00 Setup returns a comma delimited list in a single XML tag that contains merchant setup information. The list is in the following format: Setup_Name1=Y|N,Setup_Name2=Y|N StatusCheck returns "OK" if a connection can be made to the payment server with the supplied user name and password; otherwise, an error message is returned Initialize returns the merchant account setup, including Partner number, Merchant ID, credit card type, phone number, etc.

TransType

ExtData

Optional. Extended data in XML format. Valid values are:

<TrainingMode>T</TrainingMode> an indicator that specifies transactions will be processed for local loop back testing <TrainingMode>F</TrainingMode> an indicator that specifies transactions will not be processed for local loop back testing <BatchSequenceNum>Number</BatchSequenceNum> used when the TransType is BatchInquiry and it is a number that indicates which previous batch or current batch the Payment Server should query from the processor in order to get information about the batch. Currently only support with Global Payments. Valid values are:

0 = Current open batch (default value if BatchSequenceNum is not specified in ExtData) 1 = previous batch 2 = the batch before the previous batch specified with the value 1 N = and so on

Examples
The following examples show the results of testing four TransTypes. When testing each example yourself, the UserName and Password parameters should be changed. Example 1: BatchInquiry
Parameter UserName Password TransType Value Test 123 BatchInquiry

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"><Result>0</Result><RespMSG>A pproved</RespMSG><ExtData>Credit_Sale_Amount=28.00,Credit_Sale_Coun t=28,Credit_Return_Amount=7.00,Credit_Return_Count=7,Credit_Net_Amo unt=21.00,Credit_Net_Count=35,Debit_Sale_Amount=9.00,Debit_Sale_Cou nt=6,Debit_Return_Amount=1.00,Debit_Return_Count=1,Debit_Net_Amou nt=8.00,Debit_Net_Count=7,Check_Sale_Amount=0.00,Check_Sale_Count= 0,Check_Net_Amount=0.00,Check_Net_Count=0</ExtData></Response>

Example 2: Setup
Parameter UserName Value Test

Password TransType

123 Setup

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"><Result>0</Result><RespMSG>A pproved</RespMSG><ExtData>Force_Duplicates=N,Auto_Close_Batch=Y,Ind ustry=R,DEBIT=Y,AMEX=Y,CARTBLANCH=Y,DINERS=Y,DISCOVER=Y,JAL=Y, JCB=Y,MASTERCARD=Y,VISA=Y,EBT=Y</ExtData></Response>

Example 3: StatusCheck
Parameter UserName Password TransType Value Test 123 StatusCheck

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"><Result>0</Result><RespMSG>A pproved</RespMSG><ExtData>OK</ExtData></Response>

Example 4: Initialize
Parameter UserName Password TransType Value Test 123 Initialize

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><ExtData><Partner>110< /Partner> <Vendor>206</Vendor> <MerchantID /> <PinPadKeyManagement

/><LiveURL>https://www.YourWebSite.com</LiveURL><LiveURL1>https://w ww1.YourWebSite.com</LiveURL1><TestURL>https://test.YourWebSite.com </TestURL><TestURL1>https://test.YourWebSite.com</TestURL1><EPSPay>/ pay/payxml.aspx</EPSPay><EPSlogin>/Admin/login.aspx</EPSlogin><Phone 1>425-123-1234</Phone1><Phone2>425-1231234</Phone2><Auto_Close_Batch>N</Auto_Close_Batch><eCheck>Y</eCheck> <CreditCard>Y</CreditCard><PaymentTypes><CardType>Amex</CardType><Car dType>CartBlanch</CardType><CardType>Diners</CardType><CardType>Disc over</CardType><CardType>JAL</CardType><CardType>JCB</CardType><Card Type>MasterCard</CardType><CardType>Visa</CardType></PaymentTypes><E xpressPay><CardType>Visa</CardType><LTAmount>25</LTAmount><Am ount>0</Amount><EntryMethod>S</EntryMethod><ProcessingRule>OnLine</ProcessingRule><PrintReceipt>N</PrintReceipt></ExpressPay></Ext Data> </Response>

GetOpenBatchSummary
This Web service operation retrieves a payment type transaction summary of the current open batch for a merchant. The URL to access this Web service is: https://localhost/admin/ws/trxdetail.asmx?op=GetOpenBatchSummary. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.

Parameter UserName Password RPNum BeginDt EndDt ExtData

Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. The number uniquely identifies each merchant Optional. The begin date of the date range in MM/DD/YYYY format. This date will be converted to: MM/DD/YYYYT00:00:00:0000AM Optional. The end date of the date range in MM/DD/YYYY format. This date will be converted to: MM/DD/YYYYT12:59:59:9999PM Currently there is no data value available

Example
The following table contains sample data you can use to test this Web service. The UserName, Password, and RPNum parameters should be changed when testing this example yourself. The example data shown will create a categorized summary list of all transactions in the current open batch.

Parameter UserName Password RPNum

Value Test 123 1

Result:

<?xml version="1.0" encoding="utf-8" ?> <string xmlns="http://localhost/Admin/ws"><OpenBatchSummary> <Table> <Payment_Type_ID>DEBIT </Payment_Type_ID> <Authorization>0</Authorization> <Capture>0</Capture> <ForceCapture>0</ForceCapture> <PostAuth>0</PostAuth> <Return>7.0000</Return> <Sale>61.0000</Sale> <Receipt>0</Receipt> <RepeatSale>0</RepeatSale> <Authorization_Cnt>0</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt> <PostAuth_Cnt>0</PostAuth_Cnt> <Return_Cnt>7</Return_Cnt> <Sale_Cnt>58</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>0</RepeatSale_Cnt> <Cnt>65</Cnt> </Table> <Table> <Payment_Type_ID>EBT </Payment_Type_ID> <Authorization>0</Authorization> <Capture>0</Capture> <ForceCapture>0</ForceCapture> <PostAuth>0</PostAuth> <Return>132.0000</Return> <Sale>150.0000</Sale> <Receipt>0</Receipt> <RepeatSale>0</RepeatSale> <Authorization_Cnt>0</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt> <PostAuth_Cnt>0</PostAuth_Cnt> <Return_Cnt>15</Return_Cnt> <Sale_Cnt>24</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>0</RepeatSale_Cnt> <Cnt>39</Cnt> </Table> <Table> <Payment_Type_ID>MASTERCARD</Payment_Type_ID> <Authorization>0</Authorization> <Capture>0</Capture> <ForceCapture>0</ForceCapture> <PostAuth>0</PostAuth> <Return>0</Return> <Sale>4.0000</Sale> <Receipt>0</Receipt> <RepeatSale>7.0000</RepeatSale> <Authorization_Cnt>0</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt> <PostAuth_Cnt>0</PostAuth_Cnt> <Return_Cnt>0</Return_Cnt> <Sale_Cnt>4</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>7</RepeatSale_Cnt> <Cnt>11</Cnt> </Table> <Table> <Payment_Type_ID>VISA </Payment_Type_ID> <Authorization>0</Authorization> <Capture>0</Capture> <ForceCapture>1.0000</ForceCapture> <PostAuth>1.0000</PostAuth> <Return>0</Return> <Sale>19.0000</Sale> <Receipt>0</Receipt> <RepeatSale>0</RepeatSale> <Authorization_Cnt>0</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt>

<ForceCapture_Cnt>1</ForceCapture_Cnt> <PostAuth_Cnt>1</PostAuth_Cnt> <Return_Cnt>0</Return_Cnt> <Sale_Cnt>19</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>0</RepeatSale_Cnt> <Cnt>21</Cnt> </Table> </OpenBatchSummary></string>

IsCommercialCard
This Web service operation checks whether the card number entered is for a commercial card or not. The URL to access this Web service is: https://localhost/SmartPayments/validate.asmx?op=IsCommercialCard. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Please note due to ever-changing card bin-ranges and other factors, not all Commercial/Purchase cards can be definitely determined by this method. Developers should design their applications while keeping this fact in mind. Descriptions of the parameters are listed below.
Parameter CardNumber Description Required. The number of a credit card

Examples
The following tables contain sample data you can use to test this Web service. The return result will be either true or false. Example 1:
Parameter CardNumber

The example data shown will result in return false.

Value 5454545454545454

Result:
<?xml version="1.0" encoding="utf-8" ?> <boolean xmlns="http://localhost/SmartPayments/">false</boolean>

Example 2:
Parameter CardNumber

The example data shown will result in return true.

Value 4055011111111111

Result:
<?xml version="1.0" encoding="utf-8" ?>

<boolean xmlns="http://localhost/SmartPayments/">true</boolean>

ProcessCheck
This Web service operation processes check transactions for a merchant. The URL to access this Web service is: https://localhost/SmartPayments/transact.asmx?op=ProcessCheck. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. Type of the check transaction. Valid values are:

TransType

Sale to make a purchase with a check Auth (Verify) to authorize/verify an amount of a check Return to return the money of a settled check transaction to the check holder Void to undo an unsettled check transaction Force to force a previous Sale transaction into the current batch (ForceSale) Capture to settle a single transaction in the current batch; only for terminal-based processors CaptureAll to settle all transactions in the current batch; only for terminal-based processors

CheckNum TransitNum AccountNum Amount

Required except for these TransTypes: Void, Capture, CaptureAll. Check number uniquely identifies each individual check Required except for these TransTypes: Void, Capture, CaptureAll. Transit number uniquely identifies a bank routing number Required except for these TransTypes: Void, Capture, CaptureAll. Account number uniquely identifies a check holders bank account number Required except for these TransTypes: Void, Capture, CaptureAll. The total transaction amount in DDDD.CC format Optional. The Magnetic Ink Check Reader data line, which includes TransitNum, and AccountNum. Required for processing Check-Present transactions Required except for these TransTypes: Void, Capture, CaptureAll. The check holders name as it appears on the check. The parameter may be required, depending on the merchants processor setup. This parameter will remove invalid characters. See list of Removed Characters for more details Optional. The check holders drivers license number. This parameter will remove invalid characters. See list of Removed Characters for more details

MICR

NameOnCheck

DL

SS DOB

Optional. The check holders Social Security Number. This parameter will remove invalid characters. See list of Removed Characters for more details Optional. The check holders date of birth. This parameter will remove invalid characters. See list of Removed Characters for more details Optional. The check holders 2 character state code. The parameter may be required depending on the merchants processor setup. This parameter will remove invalid characters. See list of Removed Characters for more details Optional. The type of the check. Valid values are:

StateCode

CheckType

Personal Corporate Government

Extended data in XML format These tags may be required for Sale and Return transactions depending on the merchants processor setup: CityOfAccount, BillToStreet, and BillToPostalCode. Required tag for Return, Void, Force, and Capture transactions is: PNRef. RawMICR tag is required for processing Check-Present transactions. Valid values are:

<TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 30) <PNRef>PNRef</PNRef> for a reference number assigned by the payment server <Phone>Phone</Phone> for phone number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <Email>EMail</EMail> for email address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <RawMICR>RawMICR</RawMICR> for raw Magnetic Ink Check Reader data from the check reader in the format of: TransitNumTAccountNumOCheckNum <InvNum>InvNum</InvNum> for invoice tracking number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode; either T or F <AllianceNum>AllianceNum</AllianceNum> is the Alliance number for the check <AccountType>AccountType</AccountType> is the type bank account for the check. Valid values are Checking or Saving

ExtData

<CityOfAccount>CityOfAccount</CityOfAccount> for city name of the check holder's residential address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <BillToStreet>BillToStreet</BillToStreet> for street name of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details. <BillToCity>BillToCity</BillToCity> for city name of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <BillToState>BillToState</BillToState> for the two character state code of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <BillToPostalCode>BillToPostalCode</BillToPostalCode> for zip code of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <BillToCountry>BillToCountry</BillToCountry> for country name of the check holder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <CustomerID>CustomerID</CustomerID> for customer ID. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details

The following tables contain sample data you can use to test this Web service. The UserName and Password parameters should be changed when testing the examples yourself.

Examples
Example 1: The example data below will process a manually entered check Sale transaction through the payment server.
Parameter UserName Password TransType CheckNum TransitNum AccountNum Amount NameOnCheck Value test 123 Sale 1001 123456780 1234567890 100.00 John Doe

StateCode ExtData

WA <CityOfAccount>City</CityOfAccount><BillToStreet>123</BillToStreet><Bill ToPostalCode>99999</BillToPostalCode>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL</ Message><AuthCode>GUEIJQ</AuthCode><PNRef>2400</PNRef> </Response>

Example 2: The example data below will process a swiped check Sale transaction through the payment server.
Parameter UserName Password TransType CheckNum TransitNum AccountNum Amount MICR NameOnCheck StateCode ExtData Value test 123 Sale 1001 123456780 1234567890 100.00 1234567801234567890 John Doe WA <RawMICR>123456780T1234567890O1001</RawMICR>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><Message>APPROVAL</Message><AuthCode>AUTH NUM 121704</AuthCode><PNRef>11622</PNRef> </Response>

Example 3: The example data below will process a manually-entered check Return transaction through the payment server. The PNRef element in the ExtData parameter should be changed when testing this example yourself.
Parameter UserName Password TransType CheckNum TransitNum AccountNum Amount NameOnCheck StateCode ExtData Value test 123 Return 100 123456780 1234567890 100.00 John Doe WA <PNRef>821</PNRef><CityOfAccount>Any Town</CityOfAccount><BillToStreet>123</BillToStreet><BillToPostalCode> 99999</BillToPostalCode><InvNum>1001</InvNum>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL</Messag e><AuthCode>GWNICP</AuthCode><PNRef>2406</PNRef><ExtData>InvNum=100 1</ExtData> </Response>

Example 4: The example data below will process a check Void transaction through the payment server. The PNRef element in the ExtData parameter should be changed when testing this example yourself.
Parameter Value

UserName Password TransType ExtData

test 123 Void <PNRef>2405</PNRef>

Result:

<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL</ Message><AuthCode>GW5NPQ</AuthCode><PNRef>2405</PNRef> </Response>

ProcessCreditCard
This Web service operation processes credit card transactions for a merchant. The URL to access this Web service is: https://localhost/SmartPayments/transact.asmx?op=ProcessCreditCard. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. Type of the credit card transaction. Valid values are:

Sale to make a purchase on a credit card Adjustment is used to modify an existing tip amount for an original sale.This applies to the processors that support restaurant adjustment transactions Auth to authorize an amount on a credit card Return to credit the cardholders account Void to undo an unsettled transaction. Note: pass the Card Number and ExpDate with null values on voids Force to place an Auth transaction into the current batch (PostAuth) or to place a transaction not processed through the payment server into the current batch (ForceAuth) Capture to settle a single transaction in the current batch; only for

TransType

terminal-based processors

CaptureAll to settle all transactions in the current batch; only for terminal-based processors or host-based processors that support a batch release feature RepeatSale to perform a recurring billing or installment payment transaction

CardNum

Optional except for these TransTypes: Sale, Auth, Return, Force (ForceAuth). Credit card number to process the transaction. For all other transaction types the parameter needs to be included Optional except for these TransTypes: Sale, Auth, Return, Force (ForceAuth). Credit cards expiration date in MMYY format. For all other transaction types the parameter needs to be included Optional except when processing swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678

ExpDate

MagData

NameOnCard

Optional, depending on different merchant processor setups. The cardholders name as it appears on the card. This parameter will remove invalid characters. See list of Removed Characters for more details Optional except for these TransTypes: Auth, Sale, Return, Force (both PostAuth and ForceAuth). The total transaction amount in DDDD.CC format Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details Optional except for these TransTypes: Void, Force (PostAuth), Capture. Reference number assigned by the payment server Optional depending on different merchant processor setups. Cardholders billing address zip code used in address verification. This parameter will remove invalid characters. See list of Removed Characters for more details Optional depending on different merchant processor setup. Cardholders billing street address used in address verification. This parameter will remove invalid characters. See list of Removed Characters for more details Optional. Card verification number Optional except in the cases of: AuthCode (required for a Force (ForceAuth) transaction); City and BillToState (required by certain processors); Invoice and associated nested data elements (required for Concord EFS Purchase Card Level 3 and Fuel purchases- see section below). Extended data in XML format. Valid values are:

Amount InvNum PNRef

Zip

Street CVNum

ExtData

<AuthCode>ApprovalCode</AuthCode> for original authorization code <CustCode>CustomerCode</CustCode> for customer code or PO number of the customer. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details

<TipAmt>TipAmount</TipAmt> for tip amount in DDDD.CC format <TaxAmt>TaxAmount</TaxAmt> for tax amount in DDDD.CC format <SequenceNum>SequenceNum</SequenceNum> for sequence number used with RepeatSale installment transactions; this designates which number in the sequence the transaction is; it must be a positive integer smaller than or equal to the SequenceCount <SequenceCount>SequenceCount</SequenceCount> for sequence count used with RepeatSale installment transactions; this designates the total number of charges that will be made; it must be a positive integer greater than or equal to the SequenceNum <ServerID>ServerID<ServerID> for a unique server identification number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details 40) <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default =

<TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode; either T or F <Force>Force</Force> for forcing duplicate transactions to be processed; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction <RegisterNum>RegisterNum</RegisterNum> for register number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <City>City</City> for the city name of the cardholder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <BillToState>State</BillToState> for the two character state code of the cardholder's billing address. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <CustomerID>CustomerID</CustomerID> for customer ID <PONum>PONum</PONum> for purchase order number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <BillPayment>BillPayment</BillPayment> to indicate that a transaction is a utility bill payment; either T or F; only supported for TransTypes Sale and RepeatSale; This tag is only relevant to Retail, MOTO, and eCommerce markets. Currently, this information is only supported for Vital, First Data North, and Global Payments processors; other processors may be supported in the future
Authentication=<XID>AuthenticationID</XID><CAVV>CAVV</CAVV> Verified by Visa and Universal Cardholder Authentication Field Authentication=<UCAF>UCAF</UCAF>are programs implemented by Visa and MasterCard respectively to verify that an account number is being submitted by the cardholder. These programs are for the Ecommerce market exclusively and only MasterCard and Visa cards support this feature.The data for Visa and MasterCard is different.There is a possible CAVV response for Visa cards that will be returned via ExtData * Please see sample in the section Examples for Verified by VISA and UCAF for Mastercard. <CVPresence>CVPresence Value</CVPresence> CVV2 / CVC2 / CID Presence, indicates whether a CVV2 or CID has been sent along with the request.The

valid values for this tag are: None, NotSubmitted, Submitted Illegible, NotPresent (Not present on card). *Please see sample request and response for this CVPresence tag field.

<EntryMode>EntryModeValue</EntryMode> this was added to indicate how the values for the payment information were obtained. The Valid values for this tag are: UNKNOWN, MANUAL,MAGNETICSTRIPE,ICC, and PROXIMITY

<Invoice>Invoice</Invoice> to indicate invoice details will be included. Required for Concord EFS Purchase Card Level 3 but optional for fuel purchases. However, fuel purchases must contain the <Items> element for transactions of type Sale and Force. See below for hierarchy of required and optional elements nested within. Please note that all elements included inside <Invoice> must be in the specific order listed below <Invoice> <InvNum>InvNum</InvNum> Purchase invoice number <Date>Date</Date> Date of invoice in YYMMDD format for Concord <BillTo> <CustomerId>CustomerId</CustomerId> Customer ID number <Name>Name</Name> Customer name <Address> Customer address <Street>Street</Street> Customer address street <City>City</City> Customer address city <State>State</State> Customer address state <Zip>Zip</Zip> Customer address zip code <Country>Country</Country> Customer address country

</Address> <Email>Email</Email> Customer email <Phone>Phone</Phone> Customer phone number <Fax>Fax</Fax> Customer fax number <CustCode>CustCode</CustCode> Customer code <PONum>PONum</PONum> Purchase order number from customer <TaxExempt>TaxExempt</TaxExempt> Customer tax exempt status

</BillTo> <Description>Description</Description> Description of purchase <Items> Required for Concord EFS Purchase Card Level 3 and fuel purchases. Items contained in invoice. Contains one or more <Item> elements <Item> Required for Concord EFS Purchase Card Level 3 and fuel card purchases. One item in invoice (item details nested within). There may be multiple <Item> nested within <Items> tag <SKU>SKU</SKU> SKU number of item

<UPC>UPC</UPC> Required for Concord EFS Purchase Card Level 3 and fuel purchases. UPC number of item for Purchase Card Level 3 or the NACS (National Association of Convenience Stores) product code for fuel purchases. The NACS is an industry standard list that Concord is utilizing. For a list of NACS product codes, please contact EFSnet customer support at [email protected] or 1-877-852-2637. <Description>Description</Description> Item description <Quantity>Quantity</Quantity Required for Concord EFS Purchase Card Level 3 and fuel purchases. Quantity purchased of item <UnitOfMeasurement>UnitOfMeasure</UnitOfMeasurement> Unit of measurement for item <UnitPrice>UnitPrice</UnitPrice> Required for Concord EFS Purchase Card Level 3 and fuel purchases. Unit price of item <DiscountAmt>DiscountAmount</DiscountAmt> Possible discount amount on item <TaxAmt>TaxAmt</TaxAmt> Possible tax amount on item <TotalAmt>TotalAmt</TotalAmt> Total amount of item <Category>Category</Category> Required for Concord EFS Purchase Card Level 3 and fuel purchases. Item category for Purchase Card Level 3 or the specific value Fuel to designate a fuel purchase item <TaxRate>TaxRate</TaxRate> Possible tax rate applied to item

</Item>

</Items> <DiscountAmt>DiscountAmount</DiscountAmt> Possible total discount for invoice <ShippingAmt>ShippingAmt</ShippingAmt> Possible shipping amount for invoice <DutyAmt>DutyAmt</DutyAmt> Possible duty amount for invoice <TaxAmt>TaxAmt</TaxAmt> Possible tax amount for invoice <NationalTaxInc>NationalTaxInc</NationalTaxInc> Possible additional tax amount included in invoice total <TotalAmt>TotalAmt</TotalAmt> Total amount of the transaction on the invoice

</Invoice> <Fleet>Fleet</Fleet> Required for Concord EFS Fleet card purchases. Information on fleet member making purchase. See below for hierarchy of elements nested within. Please note that all elements included inside <Fleet> must be in the specific order listed below <Fleet> <VehicleNum>VehicleNum</VehicleNum> May be required for specific Concord EFS Fleet card purchases. The vehicle number

<DriverNum>DriverNum</DriverNum> May be required for specific Concord EFS Fleet card purchases. The vehicle drivers number <OdometerReading>OdometerReading</OdometerReading> May be required for specific Concord EFS Fleet card purchases. The current odometer reading of the fleet vehicle

</Fleet> <CardType>CardType</CardType> When TransType does not equal Capture or CaptureAll: Required for manually-entered fleet card transactions that have the ISO prefix of the fleet card present only in the track data and not in the embossed data on the front of the card. Valid values are WEX and Voyager. Concord currently does not support manually entered Voyager cards When TransType equals CaptureAll: Optional valid values can be: ALL to specify all payment methods assigned to the merchant account should be settled, or a combination of the specific payment methods separated by a colon (i.e. CREDIT:DEBIT:EBT:EGC) in order to specify which individual payment methods assigned to the merchant account should be settled. Please note that if the processor requires all payment methods to settle at the same time, it is required to use the ALL value or the appropriate combination of the specific payment methods in order to settle the account correctly. Currently, only host-based processors that support a manual batch settlement (or batch release) require all payment methods to be settled at the same time When TransType equals Capture: This element does not apply since only 1 transaction will be settled

Purchase Card Level 3 Data Use Level 3 data on Purchase Card transactions is now available, but currently only through the Concord EFS processor. This sends invoice information with line-item detail provided to the processor for validation. The data is all sent through the ExtData parameter nested within the <Invoice> element (see chart above). Note that if you use the <Invoice> element it will ignore any data of the same purpose specified elsewhere by way of a parameter or other ExtData parameter tag, i.e. it will use one or the other but not both. For example, if you supply the <TaxAmt> element within the <Invoice> element and as a separate element in the ExtData parameter, the separate <TaxAmt> element outside the <Invoice> element will be ignored (duplicate information will not cause a problem). See Example 10 below for a sample transaction sending Purchase Card Level 3 data. Fuel Purchases: Standard and Fleet Card Use Credit card processing for fuel purchases with both Standard and Fleet type cards are now available, currently through Concord EFS only. This functionality allows for fuel purchases with standard credit cards (Visa, Mastercard, etc) and with Fleet type cards (Wex, Voyager, and MasterCard Fleet are currently supported). Fuel purchases are differentiated at the gateway from other purchases by the Fuel designation placed within

the <Category> tag in item descriptions (see Examples 11 through 13 below). In effect, a transaction will only be treated as a fuel transaction if at least one of the items within <Items> is designated as category Fuel. Both Standard and Fleet cards require item-level purchase information for fuel purchases (for TransTypes Sale and Force), and Fleet cards may additionally require vehicle number, driver number, and/or odometer information on such purchases. If all the required information for a certain purchase is not provided, the transaction will be rejected and an error message generated. Note that Fleet cards in some cases can be used to purchase non-fuel items on a transaction designated as fuel, but item-level information must be present for all items in the transaction, otherwise the transaction may be declined. The main implication for the developer is that additional data must be passed to the gateway in order for fuel purchases to process correctly. For standard credit card processing on Sale and Force fuel transactions, item-level purchase information must be provided. It can be passed inside the <Items> tag alone or nestled within <Invoice> information in ExtData. See above chart for details on these and other required XML tags for standard card processing on fuel transactions, and see Example 11 below. For Fleet card processing on fuel purchases, additional information on the fleet member such as vehicle number, driver number, and/or odometer information may also need to be provided (according to the requirements for the particular Fleet card; for example, Wex typically requires the <DriverNum> tag). See the <Fleet> tag as described in the table above, and Examples 12 and 13 below. Fleet data must be provided on Sale, Auth, Force, and Return transactions. This information will be saved and, if not obtained a second time for a Force (PostAuth), will be automatically sent to the processor. The Fleet data can generally come directly from the cards magnetic data or the POS system can acquire the data by examining information found on the cards magnetic data and then prompting the cardholder for the required data. When transactions are submitted, the cards requirements will be validated by the payment processor and an error will be generated if the proper Fleet data is not submitted. Exceptions: If a MasterCard Fleet card is used and Fleet information is not provided, the transaction will be processed as a standard fuel transaction, rather than generating an error. Also, MasterCard Fleet allows the user to exclude fleet data on manually-entered transactions. Manual Fleet transactions present a special case. Fleet cards are different in that the account data embossed on a card is often not the same as the track (magnetic) data. This is true for both Wex and Voyager Fleet cards. The result of this is that in a manuallyentered (non-swiped) card submission, the card type cannot be identified by the account number data displayed on the card. For a Wex card, the user must identify the card manually, and this information must be passed in <CardType> tag in the ExtData parameter (see Example 13). However, a Voyager card cannot be processed manually through Concord EFS at this time.

Examples
The following tables contain sample data you can use to test this Web service. The UserName and Password parameters should be changed when testing the examples yourself. Example 1: The example data below will process a manually-entered credit card Sale transaction through the payment server. It will be processed even if it is a duplicate transaction.
Parameter UserName Password TransType CardNum ExpDate NameOnCard Amount ExtData Value test 123 Sale 5454545454545454 0509 John Doe 1.00 <Force>T</Force>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL</ Message><AuthCode>006063</AuthCode><PNRef>2296</PNRef><HostCode>0 3530EVV3K2ZA2F453Q</HostCode><GetAVSResult>N</GetAVSResult><GetAVS ResultTXT>No Match</GetAVSResultTXT><GetStreetMatchTXT>No Match</GetStreetMatchTXT><GetZipMatchTXT>No Match</GetZipMatchTXT><GetCommercialCard>False</GetCommercialCard><Ext Data>CardType=MASTERCARD</ExtData> </Response>

Example 2: The example data below will process a manually-entered credit card Auth transaction as a commercial card through the payment server.
Parameter Value

UserName Password TransType CardNum ExpDate NameOnCard Amount InvNum ExtData

test 123 Auth 4055016727870315 0509 John Doe 1.00 1001 <TaxAmt>0.50</TaxAmt><CustCode>102</CustCode>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL VITAL1</Message><AuthCode>VITAL1</AuthCode><PNRef>2275</PNRef><GetComm ercialCard>True</GetCommercialCard><ExtData>InvNum=1001,CardType=VISA </ExtData> </Response>

Example 3: The example data below will process a swiped credit card Return transaction through the payment server.
Parameter UserName Password TransType CardNum ExpDate MagData NameOnCard Amount Value test 123 Return 371449635398431 1205 371449635398431=05121015432112345678 John Doe 1.00

Result:
<?xml version="1.0" encoding="utf-8" ?>

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL VITAL7</Message><AuthCode>VITAL7</AuthCode><PNRef>2307</PNRef><GetComm ercialCard>False</GetCommercialCard><ExtData>CardType=AMEX</ExtData> </Response>

Example 4: The example data below will process a credit card Void transaction through the payment server. The PNRef parameter should be changed when testing this example yourself. Note: pass the card number and ExpDate with null values on voids
Parameter UserName Password TransType PNRef Value test 123 Void 2308

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><AuthCode>VITAL4</AuthCode> <PNRef>2309</PNRef> </Response>

Example 5: The example data below will process a credit card Force (PostAuth) transaction through the payment server using Training Mode. The PNRef parameter should be changed when testing this example yourself.
Parameter UserName Password TransType Value test 123 Force

NameOnCard Amount PNRef ExtData

John Doe 1.00 2310 <TrainingMode>T</TrainingMode>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><AuthCode>DEMO2</AuthCode><PNRef>2318</PNRef> </Response>

Example 6: The example data below will process a manually-entered credit card Force (ForceAuth) transaction through the payment server.
Parameter UserName Password TransType CardNum ExpData NameOnCard Amount ExtData Value test 123 Force 5454545454545454 0509 John Doe 1.00 <AuthCode>123456</AuthCode>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL</Messag

e><AuthCode>123456</AuthCode><PNRef>2317</PNRef><GetCommercialCard>False </GetCommercialCard><ExtData>CardType=MASTERCARD</ExtData> </Response>

Example 7: The example data below will process a credit card Capture transaction through the payment server to settle a single transaction in the current batch. The PNRef parameter should be changed when testing this example yourself.
Parameter UserName Password TransType PNRef Value test 123 Capture 2327

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>ACCEPTED</M essage><AuthCode>GB00029 ACCEPTED</AuthCode><ExtData>Net_Count=1,Net_Amount=1,Settle_DT=20 04-04-13 15:36:26</ExtData> </Response>

Example 8: The example data below will process a credit card CaptureAll transaction through the payment server to settle all transactions in the current batch.
Parameter UserName Password TransType Value test 123 CaptureAll

Result:
<?xml version="1.0" encoding="utf-8" ?>

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>ACCEPTED</M essage><AuthCode>GB00030 ACCEPTED</AuthCode><ExtData>Net_Count=1,Net_Amount=1,Settle_DT=20 04-04-13 15:42:45</ExtData> </Response>

Example 9: The example data below will process a credit card RepeatSale transaction as a recurring payment through the payment server based on the PNRef number of a previous Sale transaction. The PNRef parameter should be changed when testing this example yourself.
Parameter UserName Password TransType PNRef Value test 123 RepeatSale 2329

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL VITAL2</Message><AuthCode>VITAL2</AuthCode><PNRef>2332</PNRef><GetComm ercialCard>False</GetCommercialCard> </Response>

Example 10: The example data below will process a credit card Sale transaction through the Payment Server, passing the appropriate ExtData to provide Purchase Card Level 3 information to the processor. Note that Concord EFS is the only processor which will actually use such data at this time; if such data were sent via ExtData to another processor, the transaction would process, but the Level 3 data would not be utilized.

Parameter

Value

UserName Password TransType CardNum ExpDate MagData NameOnCard Amount

concord 123 Sale 5233272716340016 0208 5233272716340016=080212121228 John Doe 26.50 <Invoice><InvNum>123</InvNum><Date>050421</Date><BillTo><Custo merId>CID101</CustomerId><Name>John Doe</Name><Address><Street>123 Main Street</Street><City>Any City</City><State>WA</State><Zip>98052</Zip><Country>USA</Countr y></Address><Email>[email protected]</Email><Phone>132-1231234</Phone><Fax>123-1231235</Fax><CustCode>CCode123</CustCode><PONum>PO123</PONum> <TaxExempt>True</TaxExempt></BillTo><Description>One big sale</Description><Items><Item><TotalAmt>1</TotalAmt><UPC>001</U PC><Quantity>1</Quantity><UnitPrice>1</UnitPrice><Category>Fuel</Cat egory><Description>UnLeaded</Description><UnitOfMeasurement>Gallon</ UnitOfMeasurement></Item></Items><DiscountAmt>0</DiscountAmt><Sh ippingAmt>1.11</ShippingAmt><DutyAmt>0</DutyAmt><TaxAmt>1.22</T axAmt><NationalTaxInc>0</NationalTaxInc><TotalAmt>26.50</TotalAmt> </Invoice>

ExtData

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>OK</RespMSG><Message>APPROVAL</Message ><AuthCode>990477</AuthCode><PNRef>38473</PNRef><HostCode>100008 693148</HostCode><GetCommercialCard>True</GetCommercialCard><ExtData> CardType=MASTERCARD</ExtData> </Response>

Example 11: The example data below will process a swiped credit card (Mastercard) Sale transaction as a fuel transaction through the payment server. Note that ExtData contains both required and optional tags for this transaction (see table above).

Parameter UserName Password TransType CardNum ExpDate MagData NameOnCard Amount ExtData

Value test 123 Sale 5233272716340016 0208 5233272716340016=080212121228 John Doe 26.50 <Items><Item><UPC>001</UPC><Quantity>1</Quantity><UnitPrice>1</Un itPrice><Category>Fuel</Category><Description>UnLeaded</Description><U nitOfMeasurement>Gallon</UnitOfMeasurement></Item></Items>

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>OK</RespMSG><Message>APPROVAL</Message ><AuthCode>333333</AuthCode><PNRef>39081</PNRef><HostCode>100008 778024</HostCode><GetCommercialCard>False</GetCommercialCard><ExtData >CardType=MASTERCARD</ExtData> </Response>

Example 12: The example data below will process a swiped Fleet card Sale transaction as a fuel transaction through the payment server. Note that ExtData contains both required and optional tags for this transaction (see table above).
Parameter UserName Password TransType CardNum ExpDate MagData NameOnCard Value test 123 Sale 6900460420001234566 0306 6900460420001234566=06031000563100000 John Doe

Amount

1.00 <Fleet><DriverNum>123</DriverNum><OdometerReading>78964</Odometer Reading></Fleet><Items><Item><UPC>001</UPC><Quantity>1</Quantity> <UnitPrice>1</UnitPrice><Category>Fuel</Category><Description>UnLeaded </Description><UnitOfMeasurement>Gallon</UnitOfMeasurement></Item></I tems>

ExtData

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>OK</RespMSG><Message>APPROVAL</Message ><AuthCode>333333</AuthCode><PNRef>39082</PNRef><HostCode>100008 778025</HostCode><GetCommercialCard>False</GetCommercialCard><ExtData >CardType=WEX</ExtData> </Response>

Example 13: The example data below will process a manually-entered Fleet card Sale transaction as a fuel transaction through the payment server. Note that the CardType must be designated on a manually-entered Fleet transaction. Also note that ExtData contains both required and optional tags for this transaction (see table above).
Parameter UserName Password TransType CardNum ExpDate NameOnCard Amount Value test 123 Sale 0420001234566 0306 John Doe 50.00 <Fleet><VehicleNum>321</VehicleNum><DriverNum>123</DriverNum><Odo meterReading>78964</OdometerReading></Fleet><Items><Item><UPC>001< /UPC><Quantity>1</Quantity><UnitPrice>1</UnitPrice><Category>Fuel</Cate gory><Description>UnLeaded</Description><UnitOfMeasurement>Gallon</Unit OfMeasurement></Item></Items><CardType>WEX</CardType>

ExtData

Result:

<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>OK</RespMSG><Message>APPROVAL</Message ><AuthCode>333333</AuthCode><PNRef>39083</PNRef><HostCode>100008 778047</HostCode><GetCommercialCard>False</GetCommercialCard><ExtData >CardType=WEX</ExtData> </Response>

Example 14. This example illustrates the new command ADJUSTMENT that can modify an original Sale transaction specific to tip adjustment. This is applicable to all restaurant supported processors. This sample starts with an original sale amount with no tip added in the Ext Data field using HTTP POST

Response: <?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmartPayments"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>NO MATCH</Message> <AuthCode>TAS770</AuthCode> <PNRef>27722</PNRef> <HostCode>704623500829</HostCode> <GetAVSResult>N</GetAVSResult> <GetAVSResultTXT>No Match</GetAVSResultTXT> <GetStreetMatchTXT>No Match</GetStreetMatchTXT> <GetZipMatchTXT>No Match</GetZipMatchTXT> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData> </Response>

To add a tip to this original Sale transaction, the command ADJUSTMENT is used along with the username,logi, PNREF of the original sale and tip amount in the extended data field as shown below. Currently only the tip amount is adjustable. Please observe the screenshot below there is no need to resend all the credit card information data to perform a tip adjustment

<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmartPayments"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <PNRef>27723</PNRef> <GetCommercialCard>False</GetCommercialCard> </Response>

Examples for Verified By VISA and UCAF for Mastercard

VISA Requests
<?xml version="1.0" encoding="UTF-8"?><XMLPayRequest version="2" Timeout="40"><RequestData><Vendor>2</Vendor><Partner>101</Partner><Transacti ons><Transaction><Sale><PayData><Invoice><BillTo><Address><Street>8320</Stree t><Zip>85284</Zip></Address></BillTo><ShipTo><Address><Zip>85284</Zip></Ad dress></ShipTo><TotalAmt>1.00</TotalAmt></Invoice><Tender><Card><CardType> VISA</CardType><CardNum>4003002345678903</CardNum><ExpDate>0809</ExpD ate><CVNum>999</CVNum><Amount>1.00</Amount><ExtData>Authentication=<XI D>1234567890123456789012345678901234567890</XID><CAVV>098765432109876 5432109876543210987654321</CAVV></ExtData></Card></Tender></PayData></Sal e></Transaction></Transactions></RequestData><RequestAuth><UserPass><User>vita l</User><Password>123</Password></UserPass></RequestAuth></XMLPayRequest>

Visa Response
<?xml version="1.0" encoding="UTF8"?><XMLPayResponse><ResponseData><Vendor>2</Vendor><Partner>101</Partner ><TransactionResults><TransactionResult><Result>0</Result><AVSResult><AVSRes ponse>Y</AVSResponse><StreetMatch>Y</StreetMatch><ZipMatch>Y</ZipMatch></ AVSResult><CVResult>M</CVResult><Message>EXACT MATCH </Message><ExtData><CAVVResponse>2</CAVVResponse></ExtData><PNRef>192 19</PNRef><AuthCode>VITAL2</AuthCode><HostCode>514520501676</HostCode> <CommercialCard>False</CommercialCard><TransDate>052505</TransDate><TransT ime>132956</TransTime></TransactionResult></TransactionResults></ResponseData> </XMLPayResponse> MasterCard Request
CC17| ProcessCreditCard| 1| vital| 123| sale| 5499990123456781 | 0809| | | 3.00| | | 85284| 2345| 998|<Authentication><UCAF>09876543210987654321098765432109</UCAF></Authentication>

Mastercard Response
<?xml version="1.0" encoding="UTF-8"?><XMLPayRequest version="2" Timeout="40"><RequestData><Vendor>2</Vendor><Partner>101</Partner><Transactions><Tra nsaction><Sale><PayData><Invoice><BillTo><Address><Street>2345</Street><Zip>85284</Zip

></Address></BillTo><ShipTo><Address><Zip>85284</Zip></Address></ShipTo><TotalAmt>3. 00</TotalAmt></Invoice><Tender><Card><CardType>MASTERCARD</CardType><CardNum> 5499990123456781</CardNum><ExpDate>0809</ExpDate><CVNum>998</CVNum><Amount> 3.00</Amount><ExtData>Authentication=<UCAF>09876543210987654321098765432109</UCA F></ExtData></Card></Tender></PayData></Sale></Transaction></Transactions></RequestDat a><RequestAuth><UserPass><User>vital</User><Password>123</Password></UserPass></Re questAuth></XMLPayRequest>

Example of CVPresence Request

CC61| ProcessCreditCard| 1| fdcnorth| 123| sale| 4012000033330026| 0408| | | 29.95| | | 631461234| 12115 LACKLAND| |<CVPresence>Illegible</CVPresence>

Response
<?xml version=\"1.0\" encoding=\"UTF-8\"?><XMLPayRequest version=\"2\" Timeout=\"40\"><RequestData><Vendor>6</Vendor><Partner>101</Partner><Transactions><Tr ansaction><Sale><PayData><Invoice><BillTo><Address><Street>12115 LACKLAND</Street><Zip>631461234</Zip></Address></BillTo><ShipTo><Address><Zip>6314 61234</Zip></Address></ShipTo><TotalAmt>29.95</TotalAmt></Invoice><Tender><Card><Car dType>VISA</CardType><CardNum>4012000033330026</CardNum><ExpDate>0408</ExpDat e><Amount>29.95</Amount><ExtData>CVPresence=Illegible</ExtData></Card></Tender></Pa yData></Sale></Transaction></Transactions></RequestData><RequestAuth><UserPass><User >fdcnorth</User><Password>123</Password></UserPass></RequestAuth></XMLPayRequest>

ProcessDebitCard
This Web service operation processes debit card transactions for a merchant. The URL to access this Web service is: https://localhost/SmartPayments/transact.asmx?op=ProcessDebitCard. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. Type of the debit card transaction. Valid values are:

TransType

Sale to make a purchase on a debit card Return to credit the cardholders account Auth to authorize an amount on a debit card. Pertains only to Concord EFS fuel transactions

Force to place Auth transactions into the current batch (PostAuth). Pertains only to Concord EFS fuel transactions Capture to settle a single transaction in the current batch; only for terminal-based processors CaptureAll to settle all transactions in the current batch; only for terminal-based processors or host-based processors that support a batch release feature

CardNum ExpDate

Required except for Capture and CaptureAll. Debit card number to process the transaction Required except for Capture and CaptureAll. Debit cards expiration date in MMYY format Required except for Capture and CaptureAll; required for all swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678

MagData

NameOnCard

Optional, depending on different merchant processor setup. The cardholders name as it appears on the card. This parameter will remove invalid characters. See list of Removed Characters for more details Required except for CaptureAll. The total transaction amount in DDDD.CC format. This amount includes CashBackAmt and SureChargeAmt Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details Optional except for Force and Capture. The reference number assigned by the payment server Required except for Capture and CaptureAll transactions and PIN-less debit transactions. The encrypted pin block returned by the pin-pad. The transaction will fail if an unencrypted pin value is used Optional. A number uniquely identifies the register or computer on which the transaction is performed. This parameter will remove invalid characters. See list of Removed Characters for more details Optional. The amount in DDDD.CC format that a merchant charges for processing a debit card transaction Optional. The amount in DDDD.CC format that a cardholder requests for cash back Optional, except for <KeySerialNumber>, which is required for all non-PINless Sale, Auth, Force, and Return debit transactions, and <Items> and associated nested data elements (required for Concord EFS fuel purchases- see section below). Extended data in XML format. Valid values are:

Amount InvNum PNRef

Pin

RegisterNum

SureChargeAmt CashBackAmt

ExtData

<TimeOut>TimeOut</TimeOut > for timeout value in seconds (default = 40)

<TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode; either T or F <KeySerialNumber>KeySerialNumber</ KeySerialNumber > for managing DUKPT pin-pads for non-PIN-less debit transactions <Force>Force</Force> for forcing duplicate transactions to be processed; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction <Items> Required for Concord EFS fuel purchases. Items included in invoice. Contains one or more <Item> elements <Item> Required for Concord EFS fuel transactions of type Sale and Force. One item in invoice (item details nested within). There may be multiple <Item> nested within <Items> tag <SKU>SKU</SKU> SKU number of item <UPC>UPC</UPC> Required for Concord EFS fuel purchases. The NACS (National Association of Convenience Stores) product code for fuel purchases. The NACS is an industry standard list that Concord is utilizing. For a list of NACS product codes, please contact EFSnet customer support at [email protected] or 1-877-852-2637. <Description>Description</Description> Item description <Quantity>Quantity</Quantity Required for Concord EFS fuel purchases. Quantity purchased of item <UnitOfMeasurement>UnitOfMeasure</UnitOfMeasurement> Unit of measurement for item <UnitPrice>UnitPrice</UnitPrice> Required for Concord EFS fuel purchases. Unit price of item <DiscountAmt>DiscountAmount</DiscountAmt> Possible discount amount on item <TaxAmt>TaxAmt</TaxAmt> Possible tax amount on item <TotalAmt>TotalAmt</TotalAmt> Total amount of item <Category>Category</Category> Required for Concord EFS fuel purchases. The specific value Fuel to designate fuel purchases <TaxRate>TaxRate</TaxRate> Possible tax rate applied to item

</Item>

</Items>

PIN-less Debit Transactions In some cases, debit transactions can actually be processed without the customers entering a PIN number (a PIN-less debit transaction). Essentially, the same information is sent as in a typical PIN-based debit transaction, with the exception of the encrypted PIN-block and key serial number. This transaction type is currently only available with Concord EFS and Global Payments processors.

So, if the processor is not Concord or Global, then both the PIN-block and key serial number are required, and without both pieces of data, a transaction will be rejected at the Payment Server. If the designated processor is Concord or Global, then the transaction will be accepted either with both pieces of data (interpreted as a PIN-based debit transaction) or accepted with neither piece of data (interpreted as a PIN-less debit transaction). See Example 3 below. After the above requirements are met for a transaction, a PIN-less debit transaction will be allowed through the Payment Server. However, it still must have sufficient information to be accepted as a PIN-less transaction only when Concord is the processor. In order for the proper information to be forwarded to Concord for PIN-less debit (and thus for the transaction to be accepted at the processor), the Payment Server must be configured as described below:

Application Id Setup

To process PIN-less debit through Concord, the Application Id sent to Concord must be specified to identify the application in use. Use the following SQL script to change this value in your database: INSERT INTO [dbo].[AppSetting_T] ([Application_Key], [AppSetting_Key], [AppSetting_Value], [XmlProfile_TXT]) VALUES (8, 'CustomAppName', 'Your Application Name', '') In the above script, you must change Your Application Name to the Application ID value Concord is expecting, which is typically your company name. Follow these steps in order to execute this script: a) Open Query Analyzer b) Set the current database to your server database c) Paste the above script into the query editor and change Your Application Name to your company name d) Execute the script and verify its success The CustomAppName is only sent to Concord for PIN-less debit transactions. If CustomAppName is not specified, then the default Application ID will be sent.

Register Number and Terminal Id Setup

When processing transactions with Concord, the Payment Server will detect that the

register number passed from the client-side application matches the Register Number field setup in the merchant account. Once it has made the match, then it will send the corresponding Terminal ID field set up for that Register Number to Concord. When no Terminal ID field is sent to Concord, it defaults to what is set up at the processor (usually Terminal ID 01). If you are also doing VRU (phone-originated) transactions, a separate Terminal ID field will need to be set up in the Registers of the merchant account and submitted in your request through the Web Service. However, if the merchant will be doing both Internet and VRU transactions at the same time, the Terminal ID value will be required to differentiate between the two. For example, you may set up 01 for Internet and 02 for VRU, and the request sent through the ProcessDebitCard operation, from the merchants PIN-less Debit application, must send the appropriate Register Number to reflect what Terminal ID should be sent. Fuel Purchases: Debit Card Use Debit card processing for fuel purchases is now available, currently through Concord EFS only. This functionality allows for fuel purchases with standard debit cards (Visa, Mastercard, etc). Debit fuel purchases (TransTypes Sale and Force) require item-level purchase information. If all the required information for a certain purchase is not provided, the transaction will be rejected and an error message generated. The main implication for the developer is that additional data must be passed to the gateway in order for fuel purchases to process correctly. Item-level debit fuel purchase information is passed inside the <Items> tag in ExtData. Fuel purchases are differentiated at the gateway from other purchases by the Fuel designation placed within the <Category> tag in item descriptions (see Examples 4 through 6 below). In effect, a transaction will only be treated as a fuel transaction if at least one of the items within <Items> is designated as category Fuel. See the above chart for details on these and other required XML tags for standard debit card processing on fuel transactions. Note that PIN information and Key Serial Data must be passed on all debit transactions. This data will not be retained after a transaction, so the customer must be present to reenter the PIN. This is important in the case of a Force (PostAuth). See examples 5 and 6 below.

Examples
The following tables contain sample data you can use to test this Web service. The UserName, Password, Pin, and KeySerialNumber parameters should be changed when testing the examples yourself.

Example 1: The example data below will process a swiped debit card Sale transaction through the payment server.

Parameter UserName Password TransType CardNum ExpDate MagData NameOnCard Amount InvNum Pin CashBackAmt ExtData

Value test 123 Sale 4055011111111111 1205 4055011111111111=05121015432112345678 John Doe 1.00 1001 6366C0466A74C3F6 0.5 <Timeout>100</Timeout><KeySerialNumber>4A003102930003BB</KeySeri alNumber>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL VITAL7</Message><AuthCode>VITAL7</AuthCode><PNRef>2428</PNRef><Ext Data>InvNum=1001,CardType=DEBIT</ExtData> </Response>

Example 2: The example data below will process a swiped debit card Return transaction through the payment server. The PNRef parameter should be changed when testing this example yourself.
Parameter UserName Password TransType CardNum ExpDate Value test 123 Return 4055011111111111 1205

MagData Amount PNRef Pin ExtData

4055011111111111=05121015432112345678 1.00 2428 6366C0466A74C3F6 <KeySerialNumber>4A003102930003BB</KeySerialNumber>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><Message>APPROVAL VITAL9</Message><AuthCode>VITAL9</AuthCode><PNRef>2430</PNRef><Ext Data>CardType=DEBIT</ExtData> </Response>

Example 3: The example data below will process a swiped PIN-less debit card Sale transaction through the payment server. Note that this will currently only work with specific payment processors and will be processed as PIN-less debit when both the PINblock and key serial number information are purposefully omitted.
Parameter UserName Password TransType CardNum ExpDate MagData NameOnCard Amount Value test 123 Sale 4011190070070071 0606 4011190070070071=060600199100 John Doe 1.00

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><Message>APPROVAL</Message><AuthCode>216880</AuthCod e><PNRef>38472</PNRef><HostCode>100008691797</HostCode><ExtData>C ardType=DEBIT</ExtData> </Response>

Example 4: The example data below will process a swiped debit card Sale transaction as a fuel transaction through the payment server.
Parameter UserName Password TransType CardNum ExpDate MagData NameOnCard Amount Pin Value test 123 Sale 4011190070070071 0606 4011190070070071=060600199100 John Doe 1.00 A0C98099B1341075 <KeySerialNumber>1234567890000343</KeySerialNumber><Items><Item ><UPC>001</UPC><Quantity>1</Quantity><UnitPrice>1</UnitPrice><Cat egory>Fuel</Category><Description>UnLeaded</Description><UnitOfMeasu rement>Gallon</UnitOfMeasurement></Item></Items>

ExtData

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><Message>APPROVAL</Message><AuthCode>245028</AuthCo de><PNRef>39548</PNRef><HostCode>100008813318</HostCode><ExtData> CardType=DEBIT</ExtData> </Response>

Example 5: The example data below will process a swiped debit card Auth transaction through the payment server.
Parameter UserName Password TransType Value test 123 Auth

CardNum ExpDate MagData NameOnCard Amount Pin ExtData

4011190070070071 0606 4011190070070071=060600199100 John Doe 50.00 A0C98099B1341075 <KeySerialNumber>1234567890000343</KeySerialNumber>

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><Message>APPROVAL</Message><AuthCode>245267</AuthCo de><PNRef>39549</PNRef><HostCode>100008813334</HostCode><ExtData> CardType=DEBIT</ExtData> </Response>

Example 6: The example data below will process a swiped debit card Force transaction (after Example 5 Auth) as a fuel transaction through the payment server. The PNRef parameter should be changed when testing this example yourself.
Parameter UserName Password TransType CardNum ExpDate MagData NameOnCard Amount PNRef Pin Value test 123 Force 4011190070070071 0606 4011190070070071=060600199100 John Doe 50.00 39549 A0C98099B1341075 <KeySerialNumber>1234567890000343</KeySerialNumber><Items><Item><UPC >001</UPC><Quantity>1</Quantity><UnitPrice>1</UnitPrice><Category>Fuel</ Category><Description>UnLeaded</Description><UnitOfMeasurement>Gallon</Un itOfMeasurement></Item></Items>

ExtData

Result:

<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><Message>APPROVAL</Message><AuthCode>245267</Aut hCode><PNRef>39554</PNRef><HostCode>100008813347</HostCode><ExtDa ta>CardType=DEBIT</ExtData> </Response>

ProcessEBTCard
This Web service operation processes EBT card transactions for a merchant. The URL to access this service is: https://localhost/SmartPayments/transact.asmx?op=ProcessEBTCard. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. Type of the EBT card transaction. Valid values are:

TransType

FoodStampSale to make a purchase on an EBT cardholders food stamp account FoodStampReturn to credit to an EBT cardholders food stamp account CashBenefitSale to make a purchase on an EBT cardholders cash benefit account Inquire to check the balance on an EBT card Capture to settle a single transaction in the current batch; only for terminal-based processors CaptureAll to settle all transactions in the current batch; only for terminal-based processors or host-based processors that support a batch release feature

CardNum ExpDate

Required except for Capture and CaptureAll. EBT card number to process the transaction Required except for Capture and CaptureAll. EBT cards expiration date in MMYY format Optional. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-Present transaction and usually result in a favorable retail discount rate. This parameter

MagData

will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678 NameOnCard Amount InvNum PNRef Pin Optional, depending on different merchant processor setup. The cardholders name as it appears on the card Required except for CaptureAll. The total transaction amount in DDDD.CC format. This amount includes CashBackAmt and SureChargeAmt Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details Optional except for FoodStampReturn and Capture. The reference number assigned by the payment server Required except for Capture and CaptureAll. The encrypted pin block returned by the pin-pad. The transaction will fail if an unencrypted pin value is used Optional. A number uniquely identifies a register or computer, on which the transaction is performed. This parameter will remove invalid characters. See list of Removed Characters for more details Optional. The amount in DDDD.CC format that a merchant charges for processing an EBT card transaction Optional. The amount in DDDD.CC format that a cardholder requests for cash back. If used, only good for TransType of CashBenefitSale Optional except for <KeySerialNumber>, which is required for FoodStampSale, FoodStampReturn, CashBenefitSale, and Inquire with DUKPT pin-pad setup. Extended data in XML format. Valid values are:

RegisterNum

SureChargeAmt CashBackAmt

<TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 40) <TrainingMode>TrainingMode</TrainingMode> to process transaction in Training Mode; either T or F <KeySerialNumber>KeySerialNumber</KeySerialNumber > for managing DUKPT pin-pads for EBT transactions <Force>Force</Force> for forcing duplicate transactions to be processed; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction

ExtData

The following tables contain sample data you can use to test this Web service. The UserName, Password, Pin, and KeySerialNumber parameters should be changed when testing the examples yourself.

Examples
Example 1: The example data below will process a swiped EBT card FoodStampSale transaction through the payment server.

Parameter UserName Password TransType CardNum ExpDate MagData Amount Pin ExtData

Value test 123 FoodStampSale 4055011111111111 1205 4055011111111111=05121015432112345678 10.00 6366C0466A74C3F6 <KeySerialNumber>4A003102930003BB</KeySerialNumber>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>FoodStampBa lanceAmount: 6543.21</Message><AuthCode>VITAL1</AuthCode><PNRef>2431</PNRef><Ex tData>CardType=EBT</ExtData> </Response>

Example 2: The example data below will process a manually entered EBT card FoodStampReturn transaction through the payment server. The PNRef parameter should be changed when testing this example yourself.
Parameter UserName Password TransType CardNum ExpDate Amount PNRef Pin ExtData Value test 123 FoodStampReturn 4055011111111111 1205 10.00 2459 6366C0466A74C3F6 <KeySerialNumber>4A003102930003BB</KeySerialNumber>

The following is the result from using the Web service with the above sample data.
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><RespMSG>Approved</RespMSG><Message> FoodStampBalanceAmount: 6543.21</Message><AuthCode>VITAL6</AuthCode><PNRef>2460</PNRef><Ex tData>CardType=EBT</ExtData> </Response>

Example 3: The example data below will process a manually entered EBT card CashBenefitSale transaction through the payment server.
Parameter UserName Password TransType CardNum ExpDate Amount InvNum Pin CashBackAmt ExtData Value test 123 CashBenefitSale 4055011111111111 1205 10.00 1002 6366C0466A74C3F6 5 <KeySerialNumber>4A003102930003BB</KeySerialNumber>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><RespMSG>Approved</RespMSG><Message>CashBenefitB alanceAmount: 1234.56</Message><AuthCode>VITAL8</AuthCode><PNRef>2461</PNRef><Ex tData>CardType=EBT</ExtData>

</Response>

ProcessGiftCard
This Web service operation processes gift card transactions for a merchant. The URL to access this Web service is: https://localhost/SmartPayments/transact.asmx?op=ProcessGiftCard. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. Type of the gift card transaction. Valid values are:

TransType

Redeem to make a purchase on a gift card Reload to increase the balance on a gift card Refund to refund money back to a gift card Activate to activate a gift card Deactivate to deactivate a gift card Inquire to check the balance on a gift card Void to undo an unsettled transaction Force to place a transaction not processed through the payment server into the current batch (ForceAuth). Currently only available through Paymentech Capture to settle a single transaction in the current batch; only for terminal-based processors CaptureAll to settle all transactions in the current batch or host-based processors that support a batch release feature

CardNum ExpDate

Required. Gift card number used to process the transaction Required. Gift cards expiration date in MMYY format Optional except when processing swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678

MagData

Amount InvNum

Required except for TransType with Inquire. The total transaction amount in DDDD.CC format Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details

PNRef

Optional except for TransType with Void. Reference number assigned by the payment server of a previous gift card transaction Optional. Extended data in XML format. Valid values are:

<TrainingMode>TrainingMode</TrainingMode> for Training Mode in either T or F <Force>Force</Force> for forcing duplicate transactions to be processed; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction 40) <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default =

<RegisterNum>RegisterNum</RegisterNum> for register number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <ForceAuth>Force</ForceAuth> For previously authorized Paymentech transactions of type Redeem, Reload, and Activate to place these transactions into the current batch. (See hierarchy below) Currently only available through Paymentech. See Examples 2 and 3 below <AuthCode>AuthCode</AuthCode> Required for Paymentech transactions of type Force (Redeem ForceAuth) See hierarchy below. The authorization code previously obtained for the transaction. Currently only available through Paymentech <ForceAuth> <AuthCode>AuthCode</AuthCode> Required for Paymentech transactions being processed using <ForceAuth> (placed within <ForceAuth> tag). The authorization code previously obtained for the transaction. Currently only available through Paymentech

ExtData

</ForceAuth>

Gift Card ForceAuth Transactions When processing gift cards through Paymentech, it is possible to do a transaction of type Force (a Redeem ForceAuth, for example after a phone authorization is obtained for a purchase) in order to place a gift card Redeem transaction in the current batch. Such a transaction requires <AuthCode> to be passed in ExtData (See above table and see Example 2 below).

It is also possible to place previously authorized transactions of type Redeem, Reload, and Activate in the current batch using the <ForceAuth> tag with <AuthCode> nested inside (See above table and see Examples 3 and 4 below). Essentially, that means that a Redeem can be forced into the batch in two different ways, whereas the Reload and Activate types must be placed in the batch through the second method. Please note that Gift Card ForceAuth transactions are only required to place a previously authorized

Redeem, Reload, or Activate in the current batch.

Examples
The following tables contain sample data to process gift card transactions through the payment server. The UserName and Password parameters should be changed when testing the example yourself. Example 1: The example data below will process a Redeem transaction on a gift card through the payment server.
Parameter UserName Password TransType CardNum ExpDate MagData Amount InvNum ExtData Value test 123 Redeem 6032250001350000156 0509 6032250001350000156=09051015432112345678 10.00 1001 <Force>T</Force>

Result:
<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result><Message>GiftCardBalanceAmount: 10.00</Message><PNRef>2355</PNRef><HostCode>100004389913</HostCode ><ExtData>InvNum=1001,CardType=EGC</ExtData> </Response>

Example 2: The example data below will process a swiped gift card Force transaction through the payment server. The AuthCode value should be changed when testing this example yourself.
Parameter UserName Password Value test 123

TransType CardNum ExpDate MagData NameOnCard Amount ExtData

Force 6035718888880552378 1210 6035718888880552378=1012000876414 John Doe 3.00 <AuthCode>104013</AuthCode>

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><Message>APPROVED</Message><AuthCode>104013</Aut hCode><PNRef>39782</PNRef><HostCode>00000014</HostCode><ExtData>C ardType=EGC</ExtData> </Response>

Example 3: The example data below will place a gift card Redeem transaction into the current batch. The AuthCode value should be changed when testing this example yourself.
Parameter UserName Password TransType CardNum ExpDate NameOnCard Amount ExtData Value test 123 Redeem 6035718888880552378 1210 John Doe 3.00 <ForceAuth><AuthCode>105258</AuthCode></ForceAuth>

<?xml version="1.0" encoding="utf-8" ?>

- <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><Message>APPROVED</Message><AuthCode>105259</Aut hCode><PNRef>39783</PNRef><HostCode>00000015</HostCode><ExtData>C ardType=EGC</ExtData> </Response>

Example 4: The example data below will place a gift card Reload transaction into the current batch. The AuthCode value should be changed when testing this example yourself.
Parameter UserName Password TransType CardNum ExpDate NameOnCard Amount ExtData Value test 123 Reload 6035718888880552378 1210 John Doe 20.00 <ForceAuth><AuthCode>105260</AuthCode></ForceAuth>

<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/">

<Result>0</Result><Message>APPROVED</Message><AuthCode>105261</Aut hCode><PNRef>39784</PNRef><HostCode>00000016</HostCode> <ExtData>CardType=EGC</ExtData> </Response>

ProcessLoyaltyCard
This Web service operation processes loyalty card transactions for a merchant. The URL to access this Web service is: https://localhost/SmartPayments/transact.asmx?op=ProcessLoyaltyCard. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.

Parameter UserName Password

Value Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. Type of the gift card transaction. Valid values are:

TransType

Redeem to make a purchase on a gift card Reload to increase the balance on a gift card Refund to refund money back to a gift card Activate to activate a gift card Deactivate to deactivate a gift card Inquire to check the balance on a gift card Void to undo an unsettled transaction Force to place a transaction not processed through the payment server into the current batch (ForceAuth). Currently only available through Paymentech Capture to settle a single transaction in the current batch; only for terminal-based processors CaptureAll to settle all transactions in the current batch or host-based processors that support a batch release feature

CardNum ExpDate

Required. Gift card number used to process the transaction Required. Gift cards expiration date in MMYY format Optional except when processing swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678

MagData

Amount InvNum PNRef

Required except for TransType with Inquire. The total transaction amount in DDDD.CC format Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details Optional except for TransType with Void. Reference number assigned by the payment server of a previous gift card transaction Optional. Extended data in XML format. Valid values are:

ExtData

<TrainingMode>TrainingMode</TrainingMode> for Training Mode in either T or F <Force>Force</Force> for forcing duplicate transactions to be processed; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default =

40)

<RegisterNum>RegisterNum</RegisterNum> for register number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details

Examples
This example shows a redeem transaction for Loyalty cards.

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmartPayments"> <Result>0</Result> <Message>LoyaltyCardBalanceAmount: 953</Message> <AuthCode>A</AuthCode> <PNRef>27120</PNRef>

<ExtData>CardType=LOYALTY</ExtData> </Response>

2. This example shows the Reload function where I am adding 5 points to the loyalty card.

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmartPayments"> <Result>0</Result> <Message>LoyaltyCardBalanceAmount: 957</Message> <AuthCode>A</AuthCode> <PNRef>27122</PNRef> <ExtData>CardType=LOYALTY</ExtData> </Response>

ProcessSignature
Signature capture can be accomplished by using the SmartPayments OCX control or this Web service hosted on the payment server. The URL to access this Web service is: https://localhost/SmartPayments/transact.asmx?op=ProcessSignature. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName Password Description Required. User name assigned in the payment server Required. Password for the user name assigned in the payment server Required. The type of signature to capture. Valid values are:

SignatureType

Signature1 for Lipman credit Signature2 for Lipman check Signature3 for handheld application using AppForge Signature4 for application not using AppForge Receipt1 for TIFF file

Required. If the SignatureType is set to Signature4, a string value of vector coordinates delimited with a ^ character in the following format: x1,y1^x2,y2^xN,yN^~ If there is a pen-up event, then you use the coordinate 0,65535 to signal a break in the line ^ is the coordinate delimiter, ~ is the ending delimiter, and a comma (,) is the vector delimiter If the SignatureType is set to Receipt1, then you must compress and Base64 encode the image data. See the examples section below for more information PNRef Result AuthCode Required. The unique payment reference number assigned to the transaction Optional. An indicator that specifies if the processed transaction was approved Optional. The authorization code from the authorization of a transaction Optional. Extended data in XML format. Valid values are:

SignatureData

ExtData

<TrainingMode>T</TrainingMode> an indicator that specifies transactions will be processed for local loop back testing <TrainingMode>F</TrainingMode> an indicator that specifies transactions will not be processed for local loop back testing

The following tables contain sample data you can use for this Web service. The UserName, Password, and PNRef parameters should be changed when testing this example yourself. If a transaction already has an image, then the Web service will return Original Transaction Already Has Receipt.

Examples
Example 1: The example data below will draw a little square on the receipt and associate the receipt with the transaction with reference number 9568.

Parameter UserName Password PNRef SignatureType SignatureData

Value test 123 9568 Signature4 20,20^20,30^30,30^30,20^20,20^~

Result:

Creating a Receipt Image Transaction from a File It is possible to send a receipt image file through the ProcessSignature web service operation from a client-side application in order to associate it with a transaction. Due to the overall complexity of creating a receipt image with ProcessSignature, here is a general list of steps your client-side application would need to perform in order to send images to the Payment Server. 1. Get image file from hardware device, etc 2. Convert image format from hardware device to the TIFF image format, if it isnt already in that format. 3. It is required that at this point you perform an LZW compression on the image data in the TIFF format to reduce the file size because the Payment Server will only accept image data up to 25KB. Heres some general information about LZW compression for TIFF images: Compresses and decompresses without information loss, achieving compression ratios up to 5:1. It may be somewhat slower to compress and decompress than the PackBits scheme. 4. At this point, it is required to compress the file itself with Zip compression to reduce the file size. Any PKZip-compatible Zip compressor and decompressor will work. IPWorks (www.ipworks.com) is a third-party provider of software tools and they have a product called IPWorks! Zip that can simplify the programmatic compression because it implements a PKZip-compatible Zip compressor and decompressor: the most common compression used on Windows Platforms 5. Base64 encode the image. This ensures that the binary-based information transported can be converted properly into text-based characters to send in the SignatureData parameter of ProcessSignature 6. Input the compressed/base64 encoded image data into the SignatureData parameter of ProcessSignature, and send it to the Payment Server

Example 2: The example data below will save a receipt image to the Payment Server and associate the receipt with the transaction with reference number 3.

Parameter UserName Password PNRef SignatureType SignatureData

Value test 123 3 Receipt1 UEsDBBQAAAAIAI2MPzKHziuFjggAAAo+AAA/AAAAUHJvZ3JhbSBGaWxlcy9Db21tb24gRmls ZXMvU21hcnRQYXltZW50cyBTaGFyZWQvVGVtcFJlY2VpcHQuYm1w7dp/TBvXHQBw82MEO

nfhx4TIymoIldL9gUSKOkBR4gaiLFK7dNKm/gFS+GGpVPJSkkWCRC65/KAxVRmQ5Y9tKpPJ H1VXJov+UduZLHRNQGbTKDBpdRJcOMAVnjSOw0Oc7dyPt3d3vmLfe4dCFxam3gWf7/mj9 +6979179+4u9T995phJXqSvF+Hnc/h5OdNkyoD/pKW/1oRdAADSB7/Ey8oMM8wwwwzbFR OJbfKRuha9lp3TUhL/YCE2xji2Vg8kY2n32VCXoM0s5xNo969D55Cdysb1Z5UUHsAbC7PCP2y ZcUbaTFjwbcAuhhlmmLxQqcZtY0Lar+kmyuuI/Ic3l1p4mgEiueJ1TM5sQY1ULYIapRqHGqMa j1pMWlmlVRZiCWk1o4aBSTPx68yoyY2Iq5WJpRup7tCJGty9yQobzhM448Fn8Hvj60ZuGZM8 TjMYiyWPBYkxLnksSLUdKSYkf6a0ZpUbL+8qIh3iFOM/s0glylWM7wfDhLhlcesiAUtUjvkGcDlT DAb6yj64oyLpJx6QiRSTt0wmq3KSmQjRlG6wEpS6CURLum2AlKU93RKpVptufKqB5037dfvY 0p7p04btsm3gLDlAyl8xVcTk3Kaw/KrptfhNc8twUU2vzdS+MVR2ykko5ok5GkOC27/wkZc7u zBPbdjP3KeS9mmNvS3EV96pH/Zy3ffmKdreOKvajdbeiSrhE/NXB8xHLrYXOOnftNWpZfpgj+ bkuZQodACKoqWeqphQLdVfHliAMAD+AP4CT3LxKcYzpfslZ39bJqbkILds+WS12XQKVPOvlLx jKz1oKSzv+35me3KuOEb7O4MizTV1iom/NRMen+MfLKXYusetWLhTjBxpIN715f6iOGlsoNp8 ovadai5QIkavvWnxZgxdL3cqJlWRgJXhCFGukTzmJfNFYS27gBRRXg7qwP8iZrqmnJrrWFPOU AFjUXhq2viZye/wx6fP8+2DWRM/W3xNnZfDU5PifMwvxaBnVAx1MvTPG0OqwVOzgfOF379c 7Lkthi4ySykGT83I+gxdcOzvf70lrhQwq+bBKtWkA80BGoAaAB6RBLMhX4KUuiin5jgQD0nXC jAQ3u2YGbanjEEtPlOWI6cCz04TGhO8NCWnONJDIhZVLIKxqYoFOUWhtnk5OZUYR22dUGak YM2K1OWx2vckLb6NqR0dF88rDiU1eRSNJ00qqUcUGjPVVjDWmyxzAbVNdSf3UFvvUOu5B+ L5OIaN5wdKChdPr1VJ4eIZSP6Ci2dfssydxlO1/+N4Lv/oiJLC9Hd2JJnC9Pd11TD9nc1Olonp7 wl1noHp71E1tRf6u2GGGfYtssltjNG15RO2m/t+KLaUtFkR2yQr7b8Cgp+OUYhFe2j7aYvgXxt HjZ3OGgwfFfyWN9AyWXlT8DveROuyJG+KNjNrwbQBu+yylWxjY1hbPnEup2vZ3DoU3o8YjO c8YD0++xkKMRjPeXjT6bPXo8ZO5z3oYnNbbx2yoAbAvHJfjOZbkp6Iyhcll04bkMUww76lZtn GSF2LBqquVliKnyltIKdsJXcPr7ZezTyYU6H0zTG34wz4cMTOAN8YzQYZt70p6BlT5uzvur/baPl w5K0OxdZeftU++8VR2bjpvMGw9WZG6TjptQ2xC5t/uvjGj93hlPHzt9IzeN/ovzoXPG57Y8Izq txbyFYhPTGZai3KPpXTej2z4Eb5Hoy1vkX7LpftIwewxs6TTc1bT0zTTKCIH9zXMW4avDVJzuD L9JD2Jp188ZeO5WcBfF22a8PumPyeQi8fqWeLReXke6WF56jezFdMGmO9Mdcc53GDuaDHr 7FNb6xj7jlooWLvEY1FzWWHxqv6z1P3yl9waMuE90chjhRAKO0loVIXuPF7YE3AFQjvqO17x+ JXql64m+skSntf/955jbFe2t55nwL2RsozqrFYANqsYre11nfYHDvgJFYnrN4L2jKB0CFNvxgK+J C6gPhPJl0AOF1gv9Z2o+27YdG+c71diSstOOMild0gwVRibYh+FrCrUawF8n7XxfZXYE3aYnX qIm191YG17drwVIzA22I+F81rK8Ia6wFck9eHtc0pgo/8GT9GRj/36xocP7mmIL7MxTLi3wUT 2sOwR+OpY8snD1O99fk95bn1+SaTNc1YOGrCoRNegYM+x0J6vvUxDkTqpi8MRepmtMaOc ZSeJTwjumVGA2VgUK5JT5mtJN12o+27YdHCC9k2Em/wUhSidPJJ1qBnebdK2/XK3K4umpu mx23DXrL4tbLT/PCN7IyX0PtNlo41ix/N0/YOErHYao1VHJ53v4+ztdbT/IEbFfnjqLGMPPIwgEE tPiC/lZ0BovWJte+/sR5C39Z08sV7svm3a5mwqQI1Yd4trtwH9NsUxhYqxblZwPWPY6ynQeyt Y2LPR1DbJMAjEgBaBKitE9JbTRCNY0xnMcwww3Zg8avHKQD45x5EPkHm0AL9urTtAE1CDLX j+tZbDcsE3V9Ojs1oLfk+7ixoRvMp7zf51ng4OqC1b9q+3TQyfRIq29L1wxS8V225c/cS0gbW Kz2HFvxUlxdpOxtY0rc+KZ6C/8uYFy1THjgFP9MVJJG6yJui7Z+TD53fpH2GGWaYYU/GyJ3Ze yUvnoCj1qyLEuumWtMtyH7shteKL2C2oM+XboFi2f5oBaDY50+3UG1OAxxBPyaB+PDTbo2J 8mvCEQKIQQ+dbk5e/o+M+QQAdVPVTzmeS9sYp2N8hqX3Vf6S2ebC5Oti5h4KPj9FYMzB3A uCrjsNOOt2PTh4ecm8YsHYWSYCBN/WU5rUulywTKbdIe2R83MHFp+4xLeVxm+aczPbtSaQ NVyzQxj1zwUpxHpi3LhDuO1vKkZtupxbyeerzSfLnVrbJGIcwQkkvF1H8sGbJJ4ACdfWO869G TPDNPYfUEsBAhQLFAAAAAgAjYw/MofOK4WOCAAACj4AAD8AAAAAAAAAAAAgALaBAAAAAF Byb2dyYW0gRmlsZXMvQ29tbW9uIEZpbGVzL1NtYXJ0UGF5bWVudHMgU2hhcmVkL1RlbXB SZWNlaXB0LmJtcFBLBQYAAAAAAQABAG0AAADrCAAAAAA=

Result:

Example 3: The example data below will save a check image to the Payment Server and associate it with the transaction with reference number 5454
Parameter UserName Password PNRef SignatureType Value test 123 5454 Receipt1 UEsDBBQAAAAIAAJt9zC2UqllAxYAAEAYAAAzAAAAUHJvamVjdHMvU0RLL1RQSSBTb2Z0d2F yZS9FUFNDbGllbnQvVGVtcFJlY2VpcHQuYm1wdVgHXBPZ1gcMEKoJXQkQEkQsYKTHFkoksE hRUSy4kbWBjSKIojBLQIiABBBlxQbIYlsXUCwrCyMgC+uiUj6NAhKpCyIiLDVlzjdB93v7vvd7Jz Nzz71z59w7c//nf8+Jj4/CYgUFBXX81FFUUCDgpbw4p6j4t65kojhHYc6sjrcoqnzV5RctBSW8 MMDPAUXtWZ0qv6U4d1bHbSpSFUl/91Fcqkj+26ZiuKLOVzvymsE/xjL8WzdoUpyvoPy1P1vR +P/0dYpWX5/FLSsun7WvimsBirazuh6uBymunNVn5ymX5bYMe4ajA4OxnOHkxJCLvb0j3h6 w3NbO3sHRyZkRQKX+rTMZflSqg72drYLCBrYP1T0sMtwG77vWHX+eEfrvtr6Yb/g61mxpa7P chonfkI+ygrEcP6hyRX4oQFb+KiI94ZeErGbKIoqaSzknPWH996tWE/mn5zAOURK6Oi7pMX0j nlHKnlFqz1Iy+4K3bLjgadXhdPkn+0Enz/Kzhc67EyKH+qLohfRCy3TaigVbw5OiOB4B88wcTz erpBU6H3QW7CX+etyIHcVhn3yUFO6oGEv+N4ka8osaFEYNJNgbdedubdZmauYwwz0jd2Xz 6s1VnfspLzatVfHv0w56xsCnkdB1nqncUda4JVbPcqPLyeE9Amv7gYz0ZlP6PYW7nN0RWd3H Qg2+u7UqLeGHvf8juGjrrOvq+nR3MX/giam6FdvT2EyPqRJDP1L98UdlW0UDFvVXk5+CLA2 OyeIk4jsIwBSUwKx03L+BfmABBhOAypAK2CQvPuG1c68DwewT+ur3R3UlgHRvdatEiqOVtD wOzDM6MSX0pFar3pFF+7Cwu1YfzvrFzoT+qHw+i7aVfQdgcLASEQe0+aEzEQOxCCrIdQAY1 c4240rtBT9OQcO1SoYXAgTt3CQUs77VhcBrLR4XotuJy+Dd4QQEKzTO50KQJMAA/asAXsOk MMwbJrNshpfB+Tx/Un1ZA2kh3N7OhfCaNhTbdjZRQ3NxC0ajrUQmsG/I+JKQq3NsXS/UXws KeXkvQZMYv8bOnfr2aOya7eBGawpWIYW2hRaXflw4WaDqhQzbg6TSXtaKQuj1OFmcbCBTjI

SignatureData

41Be3p3DGyfes+m87TIox0eAgePPYDyTggQpisPyyBEj3wRKSnKl2hsF6a9HhiKYLA9BsWGv/ oFqCWtd8h2MWZXYIKDzNxkWhpxMeyWhjb5wKPx+ql9yqOycRalw3hlgr09MzEfATk7VA0SO /ltnuf+CCTWlZ9urq3bZ8ZSL4RChFsaDkSavSQ2DNOFCAzcw0clxw/jrlXTTKPjbw7w9rc5oVC 3BoJAuVnQTh8MhAm8ybE0AYdDtOn3qPS9HAfFVIwMZjIT7PKJ6Xx+TtT8tNZp+Apm80OiS6 pgp+zsT23HGgr6L+NDWSoJi6kCWDtI6G+4cEMvAvXbLRc1674zYZ5CneZ7le0qlZfMYQvQD Zda4IsffQILpB+Lzh7oeAKMSSDL2ZdrYds3qq9F2osOHQyv8kl0ck0I0v6xCUhyYj6yu7Qxvsw WHx5aPJyy1TID5/eYeOo9KVHfPqId/9vZ868nqlwDFa9SG00ngiD8XcrWgfjooZ/hEEndGgQw Sq4LRCIfwKoRAY/s4+jkNq2UfDtEniwuEQWI4zPTYUuy0XLkO7b0dO31Zbp/4VePwDv7iATc WGj3Kmh9nN1LEzrWvvtadoq6WtZ90xZTfzBkxEFPfBuS1p0MXZRzD2eIYy7DthagEPI0EUW wMaeEqzqzB8gu/8Bk3gDF4Zvn9h8XiRlnEclWiewKyAN2FwvMjf9GIhKSOj+84C1bteIkToIy4 dV8kLvtIWW4ID8h7Dgq4w0/OpOb5Z+fsG7pB67kH5Bmj6v+IBd4+glu3qxlDrhozrA8rFv9b EHLK1y4E1/Y3X5AbHj6vlWL5qvrlp/ZZtBY7s9XSVor2Z/mPNezQkQHx6/GtYSVl7+YXDw9W Crn18A7xYCLUhJSTFqsgO5vv6K1curAt2cT7J5HSNcmIoVDJBNfxNeHpGVNLTplG1O/A2NHR TCxIuR7iJfv7oNnVV1Jx0659Pr9H3tzRfg8724pOq1eOQ2msdqdObROx9fdwbARB1v+jn9dRE HYzynZCh7nW/OJ6mFCQKisv6j0uN5xX+JKw8gI8IPgyH003wUJkZG2kXcpcf9RCAlm159qcD H0MGFgAlP7Ig62Da1n6fy+/hVCfdMxuLVgt7DzWWIrPzhfWFxu/cfz3+cfHCntTXUwcdhE1cfZ tR2TTrfVGelDu362flGTyqpCcc2nw+S4EOqB96VvNlemqdpmUeG98/OyTEeiC1iYeg0PmEU/o uUyGAIEPEXMpSWJ2WZGMrpO4rTKC8i6YWrdpCbTcjNZvTCFV8OG/5ABn6ckVdmNfkxYyLv NfbPLjNJcjO7Z42xT8p7CejETHzfQMXkEDZ7KyWTxrQ4VXQqv4l/1qSuOIk9K64Fetle5mT8sZ 0J5mSaNr4drN8Ad1M8Cxpcn1FIlt96WWS5F2Wv1c52q7ZlkmvIzZQNK+jJOl56K9ya3c8zd2 W6virmcGUWRLyJ6Z6zwsuCmMHzoqWEmpP1npIs1cyd+7Txe/Y0WnCLVQRlgUGNGQQTWu Rmk7K9LFKPZluFu2R7pq5kd3yy1mPWE9Qs8kguSbzP/t3NROf8VJM0rpT9H+KjEwMG6Eyou gX/Ayr2QkZDMtD4be4hgqJcsF68jrZGODSe7ZmBYjX0YUTiZcEHsF6q3k7Ee20t2OJamOITj/ qU8gA7XX25B2RL15C4MFSpAVDhEw+jAURBPIru5A/BVHsc8ibWk2yCyNIO2a6A6d26271FU qPD2ROgdbOT37SHEMKXEDg7oD+5hn7t3npeiIOb28FXACf28xZq3XQOIZtESz9aS46Onz3c 9QjivVVmmiHOafg+vMegBVroJdjzuaI7E0hUtiy+V4Mq7KwUYs04tDeuZlVaC7AWb5hJtNnT W6PFNNXdRygzFsrsOVy0hVjbdjTL/40/+7gS/U0wlT8I49n4xGX7ZaudknWihj40m8RXbbMu mQraHOAoKSnKhvGSbVD4tkbi2+YdbIm/WpfJKHC/zTLZqJenhw8oixXJsA7GFXaHBYq0oNEx nfPLyGQziIh7kOPgk73POm0twi3xDWk9uNGfjRzw7F52hR2F0K8RnxtzSFyM5oz7xaicq3Uok SnOvfVWRzL8+4n+8zavO6Ltpu3fT6nN4lgd2erOo4uwX9RXuhKsCQZWOEovW+CAdc13OU vcwBhWImRSvfTkgHHL9lKil4hu7l2xkB0VTG5Or8VBvkRnfm1R1i4eocUlwT7psZfFS3pDDdF8 Z4KFf18GUZeQ7WWfWd7Qb70AWpYWk03ItRakee7nCoJwUPv3bXXPYW60ikxZkqDkZepJss gszzJR9yKmulnTik+d+12JgIN8YxFRZ602MeNUzvqJDwFjLjoJpQK5w/+HCEae9uqytVzLIy8o o2N6mxPIYwUUD2/5C2Wwj9DrbeVuyUg3h4HPxt1fGJkOLVpCaAmDb6uiQDTJmZdwyZ7jth 4kj+3Xdz1e5QSgHNihA0Pi15mnWmMlgIWKRThNIPAJBSEmevhwCCZrvA3pyXXL4Dv9exTrJ JA7BiKRMwkX50iZzaF4KfLtoXi8jmmASNwFqBnAcznVTMAIfh3FtqUtP1a1wzitkGmIdywg+H dReRrEghrCJFEfwbZ973q3vn6qcwn0FW1+MDIdD9hvnNdLiMuSSFwudrOGKKgV4JGch3Gpn D0QWegjnMJe3f1UwvrB4/gdE/L4DsO0pzEw1mJPFm0rOoNXcSJKK+IPtNF74/BdH+MRutzo gL1BIhDY1vN0F1YH0P9wtBadbk+Bz+wTCHRV9reqn8WIBokgrhECFvtX86PHjsJpKheIy3K6 yE0uV6ZvRKwVgoRIPlFD4BTi56WJ9OXkEI82cvFDcmgBYIPxZ6v9h2bXCWASO3fjBBdkiH4X Fpf117ykCKOMtc29HA/bAUGW3NG8pXRBO0a0Xp1kqKak7Hf/N3zrFPslHkBqhV2jEfiHbYmVr b59QAxaU0RdFGb23V7IwZf3mmK2Rt22wYLiMI3Uem8i6XMCyyqcHU8j2hB7kjiABfry25bw2 YsZp6MiyE8a5/tbmn/73NSc49+xxTX4tx7/oM0sWLDzG62NDU+DGuT0bebIH8C/KudLxGM GDcYEyqeQJepORNd6Lsw2gbTBTb6M/21z+brjg/CrJgMxVCAYKi+HcFDgPwDhkmxkquGR+x w7O7fVphnpklWNBIZ5w/vGxvQ9bxuoCAQYueYPb3IYccVuAtz3lWATklZ4gfnuqQqy3wEzGU HHw1tlhgjsCHu1eqjErwji+6KuYqzOOjxOlcaL54PInFaKyMYWpA4arAQzGC3FmFdAdhLBqhIR xsR48NigZOYqYDuULFidNkSS+PzIvQ/LpHg6kOu+7w6GImollSWATQqFkuvt3svj23JRMOdS No8NlzR4SkN+PTCij8Dk1Za4KdktOIrCeI2m9dD++1JGXkzo4C2Y/ttH8fhTgFOsDJEi2NZzy0 AEDaXFBMe9NbpZ0+OIo11IkxvP6UqjeviZP+m7WeDn51dR0Vq5scUPeouvJCdrPp3vdMuhK vZMWH/BnUE6B8CvtQSVgE/oRoCPJ4xorNjH46wbde5mMKV6d0dldO+2XVkmB88ULQNpWs LHFfFEQR1r4k0YSKt/NbUhm/38y8TzC8X9ploA+Z2etQeGnq/5E/2r8205wF9+2MnRkSlMthp AInk9iQ4jpeceIhDPjtiujw7RmKTuKjeXD2/wEHF+253r1+OKLxfrVnDhX5meTrMG9PwLAvIln 5VxmKkHMYqvwldMIF9CE2Q2FpFfRH/nZf94VAxT5/PrYKxxC8cjLrv/eB5hhXrUPCplxmS9JpX 6As+YtiZodumpaYWV5s2tCZ8xF8Fw/umKmHhfc91nNvPtzp74eLEthAXtUbpHX933PVvU7js RPQ3Y0GHJaIFXGQ5n6CyJmwxGZCU/wIQo6NNMykku2hFohs1chofD4+iQ5creeqF4GnYVM 53+zDKFwapLORe+z50QhU3ZL4mNcZ9oFdWjWEWgGFv5QdoMKMSL25M1TjDf7YgNnPmD OZCOTJUcetwR86ri0GasJVlfpcxs4tdzauVt3ww+Ntba/s2rQ+pumUPwUej33Z2p/LrlanFPPVC 0mzav/bRRJHVZz0yJTcp56L9zssYpq9d68TYICnWsJt6H+BDMScbSHwIuyh2e2m5t61kDAZ Wvo9Zus1vraTvn8nkPlUC7l3RiLUPQ13M8mfPy2vFjTcZZb00MVelJNg1deZw9zRQGhzZzNMx GL6ORfXSHoUq2c2hWracgq5uZBVBct0+h0b4x1S6k0Ilca5WhtTt8u+ZNJVWac14j06g3kEw 2v7Qdnq79IbLe/AZT2fwZpeBZ23p/cpu/Q9aT0VyV3iO5KpQUijRmjV7vrqydP/Tfe7t9kVWw/

wm7s5GJSw7sibB9OQsbox8ijanXV6vv1kXwXeTA/6MQ6T0m9x+YAa4MJ0Uhd0SOHdyf7vH VfRtcTjn7QfHlEhi6DjPKHsVs2zVRpJykhaTXlORF1EUkzk4e6S1R75L7lsjwPsVEl9773j+vsy0A 6Tn1PFKrFSNvfwgxcd2FeUZk+1ZfoWtOz/x3cuuDQwgU4+ME3dh7b2t07ry4izcex4lyt0ZcvC txsMM5EGK0J9AR37hPXncvT1RNiH8ZqMQnfMYYLZngDo58IUDYBAMnYArPTOUi4aKVyAj04 LAz9zMn0AmAOWA9uL90oxMw17UEb8ffdMAaH/3nq/B7hOd3kZTP37AmtmWOB1v1wIuZX 2rp6ltLNwGmt7gt6uqMkV6+tUhNFdKG8G2oq6o/T42FmRwX6yzIRadFQkhyC9lzsitLS6MXxL QPngtX7XbnxzGNouXsKxLB+PuKQFzjesOVZT19AC8MR8f+BHSMAXhohH9nBHxi5N5btQSfz xpU7p4zIt7u772IBzdFAOT0wdR9zMMQTwC5nVfFsnjh6xoB9vizMJjHb/VxQEdnSCuz55R9PL h5jLTGX83MTI9G/xGr2LFhskqIPaiA+z6bVm7YHFxj8Lj4ZnFqZZJm08ZFrH9G2Dg1WLu9gj8 Yz8k1Ogr5VTFPjungyUYQqy+/VLOW8VNC1537z/rKzGyIO/SfFHb9FKRJVih3Tk9L9jR3I1jMn aNtoZFJc0lofOb4IjFjwUMh1eVP5ro6jo4bPVGJZvGu8To7gtj1c0y+KSEpukynKUjL3f+9957oz P1LEi5QHDy7PEefBuvQnHeraCp2EbuyjJUjnfdmPfns1PB9IR5F2W/MDKBYnqQ2ffagJGa4ZxD 1M2MSaXPvakX4siM7eAmtq3TvPXGij+Wf3htZ/7vr+6Ytvfba7g4vTWNsPn5W93Cmfuvf+44 Q8WIVLcVyBRuPUrtMLkV/5/qoP3L+G5dszX6ejgal6ZuXKonV2ivmLW/imOB9meZ/UHqS9Ms pZDOChnrlDQty/XojF/40x4RWb9nHdE/Spfc1ZqQVOi9QVvV3KectajZLMhy35r/ni0kPHtIHyC ZKi7pOhfZH1tOY5Gry2Grz96l/RhKZy5vWavMInJpFL5zDtOcSg6kv+pjvT1GuW/Z2CDSOaLs fjDR5z+tOgQxdzMj76cvuWuc/KT18WU+giceCXzrzu5D6ypzprqyxNWq5iwnqRktPxnAHzBnD 5weVCI7XKT35a51pK1yV6nfJxGbJx5JriIb5GSyxTTaxoMW8Hs/KYhwuv1QoCnzBpBhFprDKE /Skhj085UKW1DH3DE/5Usx6KaPUpYzXRTnJeLSYcswaIWgoH0hMp/rKkjQ647j5+06oEwU9 dXFiw5UgKAp+dtK9Rmta8IC3LlQr622MCZU/oK9OH0txDVSz4VRTIsa1UIIGQcN0OUUnuVnv BNnr7ffROxOI1WldSjXKm2vJBm04Lc0nkw2Swoce8Epds96aEdRX6WsTDXmEqs4EJWTQo6 E/6EqEqEb5c6rpM3wp8ERzTz9pKcmqnri0J8nwfcIuLTZC5pHJevLwNPhfgXvqSJKGptWWUcy 5Pn662nydvdoWl1sMlxw2ycaIn06uJxtSjnJc9Vb/WOrdc3xXSrgLStaZp9Bm7z94EM+cI8jBb qTMB9a4vTSiB4nPL2/4y6jAkxpQrb7u1yQ2783OI65B7p541nNT5XKCXi+RUvaC6evfH7n8W TZPveeK0kc3Nxy5PUS5dyV7Gt9dIOW18FSTd9akUHc2ftbRUU30L0tZdJl7byG11icg8fCT7A5 vl+JDZPYhw93hbfS7eC4x30Y1cWv6G1NV5S2HkirOJ9hz5lQX/WLmsbPN0/Yh+UmHwPj5Nfr moLlaEqa5ZgEO1xxXz0XryhoOZGzpY86p7ZrcsDFzP2V8aYRz/277t1o5jF69/QH4C50mRaZQ E/mnD3tGpqZ309iUm/zThH1+maVPvqQ5+lgZKJBm/1v/X1BLAQIUCxQAAAAIAAJt9zC2Uqll AxYAAEAYAAAzAAAAAAAAAAAAIAC2gQAAAABQcm9qZWN0cy9TREsvVFBJIFNvZnR3YXJlL0 VQU0NsaWVudC9UZW1wUmVjZWlwdC5ibXBQSwUGAAAAAAEAAQBhAAAAVBYAAAAA

Result:

ValidCard
This Web service operation does the validation check on a credit card. It checks the card length based on the card type, performs a mod 10 checksum, and checks the expiration date. The return value could be: 0 good, 1001 no card number, 1002 no expiration date, 1003 invalid card type, 1004 invalid card length, 1005 invalid mod 10 check, 1006 invalid expiration date. The URL to access this operation is: https://localhost/SmartPayments/validate.asmx?op=ValidCard. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter CardNumber ExpDate Description Required. The number of a credit card Required. The expiration date of a credit card

Examples
The following tables contain sample data you can use to test this Web service. Example 1:
Parameter CardNumber ExpDate

The example data below will result in return 0.

Value 5454545454545454 0509

Result:

<?xml version="1.0" encoding="utf-8" ?> <int xmlns="http://localhost/SmartPayments/">0</int>

Example 2:
Parameter CardNumber ExpDate

The example data below will result in return 1005.

Value 5454545454545453 0509

Result:
<?xml version="1.0" encoding="utf-8" ?> <int xmlns="http://localhost/SmartPayments/">1005</int>

ValidCardLength
This Web service operation checks for the card length based on the card type. The URL to access this operation is: https://localhost/SmartPayments/validate.asmx?op=ValidCardLength. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter CardNumber Description Required. The number of a credit card

Examples
The following tables contain sample data you can use to test this Web service. The return result will be either true or false. Example 1:
Parameter CardNumber

The example data below will result in return false.

Value 54545454545454

Result:
<?xml version="1.0" encoding="utf-8" ?> <boolean xmlns="http://localhost/SmartPayments/">false</boolean>

Example 2:
Parameter CardNumber

The example data below will result in return true.

Value 4126196901499

Result:
<?xml version="1.0" encoding="utf-8" ?> <boolean xmlns="https://localhost/SmartPayments/">true</boolean>

ValidExpDate
This Web service operation validates the expiration date of a credit card. The URL to access this operation is: https://localhost/SmartPayments/validate.asmx?op=ValidExpDate. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter ExpDate Description Required. The expiration date of a credit card

Examples
The following tables contain sample data you can use to test this Web service. The return value will either be true or false. Example 1:
Parameter ExpDate

The example data below will result in return true.

Value 0509

Result:
<?xml version="1.0" encoding="utf-8" ?> <boolean xmlns="http://localhost/SmartPayments/">true</boolean>

Example 2:
Parameter ExpDate

The example data below will result in return false.

Value 0304

Result:
<?xml version="1.0" encoding="utf-8" ?> <boolean xmlns="https://localhost/SmartPayments/">false</boolean>

ValidMod10
This Web service operation validates the credit card by performing a mod 10 checksum on the card number. The URL to access this operation is: https://localhost/SmartPayments/validate.asmx?op=ValidMod10. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter CardNumber Description Required. The number of a credit card

Examples
The following table contains sample data you can use to test this Web service. The return result will be either true or false. Example 1:
Parameter CardNumber

The example data below will result in return true.

Value 54545454545454

Result:
<?xml version="1.0" encoding="utf-8" ?> <boolean xmlns="http://localhostSmartPayments/">true</boolean>

Example 2:
Parameter CardNumber

The example data below will result in return false.

Value 545454545454

Result:
<?xml version="1.0" encoding="utf-8" ?>

<boolean xmlns="http://localhost/SmartPayments/">false</boolean>

AddMerchant
This Web service operation allows you to add a merchant. The URL to access this operation is: https://localhost/admin/ws/admin.asmx?op=AddMerchant. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName SecureToken ResellerKey MerchantUsername MerchantPassword MerchantID MerchantID2 AnnualSales BusinessStartDate CompanyName DoingBuisinessAs Url FederalTaxID StateTaxID SalesTaxID OwnershipType AutoCloseBatch Value Required. User name assigned in the payment server Required. The secure code given by the payment server located at the Preferences menu, under Password Optional. The key of the reseller under which the merchant is added Required. User name for the merchant assigned in the payment server Required. Password for the merchant name assigned in the payment server Optional. ID for the merchant Optional. ID for a second merchant Optional. Annual sales of the company Optional. Date the business started Optional. Name of the company Optional. Type of company (ex: retail) Optional. URL of the company website Optional. Companys federal tax ID Optional. Companys state tax ID Optional. Companys sales tax ID Optional. The type of company the merchant belongs to (Ex: corporation) Required. (True or False) Set the close batch automation

AutoCloseBatchHour Required with True, Optional with False. Set the close batch time FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactFax Required. (True or False) Allows duplicate transaction Required. (True or False) Required. First name of the contact person Required. Last name of the contact person Required. Email address of the contact person Required. Day time phone number of the contact person Optional. Fax number of the contact person

ContactStreet1 ContactStreet2 ContactCity ContactSate ContactPostalCode ContactCountryCode TimeZoneOffset PaymentMethodXml RegistersXml

Required. Line one of the of the contact persons street address Optional. Line two of the contact persons street address Required. Contact persons city Required. Contact persons state Required. Contact persons zip code Optional. Contact persons country Optional. Hours off time zone Required. Extended data in XML format Optional. Extended data in XML format Optional. Extended data in XML format

ExtData

Note: By default, sending the email to the new user/merchant is set to false but the system will send out an email to the merchant by adding this tag: <SendEmail>T</SendEmail>

Examples
The following table contains sample data you can use to test this Web service. The parameters should be changed when testing this example yourself. Example 1: EFSNet This example table shows the information needed to add a merchant using the EFSNet processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName

Value admin jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex1 123 FALSE FALSE FALSE John

ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>EFSNet</ProcessorID><Paymen tTypeID>EGC</PaymentTypeID><HostBased>True</HostBased> <XmlProfile><StoreID>richso01</StoreID><StoreKey>A011CD0 9BB77BD85530F6B2FD3BD8550F62FD377F68798DD1EE0653E6DE 5AED2</StoreKey><CurrencyID>USD</CurrencyID><IndustryID >R</IndustryID><DebitSurcharge>0</DebitSurcharge></XmlPro file></PaymentMethod>

PaymentMethodXml

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>307</Vendor> <Username>ex1</Username> </Result>

Example 2: FDCN This example table shows the information needed to add a merchant using the FDCN processor. The parameters should be changed when testing this example yourself.

Parameter

Value

UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

admin jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex2 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>FDCN</ProcessorID><Payment TypeID>MASTERCARD</PaymentTypeID><HostBased>FALSE</H ostBased><XmlProfile><DatawireID>00003F1FF8B71A94485E</ DatawireID><MerchantID>00001210566</MerchantID><Termina lID>00001367275</TerminalID><IndustryID>R</IndustryID></ XmlProfile></PaymentMethod>

PaymentMethodXml

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>308</Vendor> <Username>ex2</Username> </Result>

Example 3: FDCNorth This example table shows the information needed to add a merchant using the FDCNorth processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex3 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>FDCNorth</ProcessorID><Paym entTypeID>DISCOVER</PaymentTypeID><HostBased>FALSE</H ostBased><XmlProfile><DatawireID>00000B81C6C0BA03F945</ DatawireID><MerchantID>000000925990</MerchantID><Termin alID>462862</TerminalID><IndustryID>R</IndustryID><CSPho neNumber>123-1231234</CSPhoneNumber><URLEmail>[email protected]</URLEmai l><DebitSurcharge>0</DebitSurcharge></XmlProfile></Payment Method>

PaymentMethodXml

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws">

<Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>309</Vendor> <Username>ex3</Username> </Result>

Example 4: FDCSouth This example table shows the information needed to add a merchant using the FDCSouth processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex4 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>FDCSouth</ProcessorID><Pay mentTypeID>AMEX</PaymentTypeID><HostBased>FALSE</Host Based><XmlProfile><DatawireID>0000D900A4BF93DA74CA</Da tawireID><MerchantID>67888886496</MerchantID><TerminalID

PaymentMethodXml

>99</TerminalID><MerchantNumber>67888886496</MerchantN umber><TerminalNumber>99</TerminalNumber><QualCode>25 800000</QualCode><TransNumber/><AMEXSENumber>5041079 856</AMEXSENumber><JALSENumber>0000000000</JALSENum ber><JCBSENumber>2222222222</JCBSENumber><DinersSENu mber>4444444444</DinersSENumber><CarteBlancheSENumber >5555555555</CarteBlancheSENumber><DiscoverSENumber>11 11111111</DiscoverSENumber><IndustryID>E</IndustryID><In putDeviceKey>1</InputDeviceKey><DebitSurcharge>0</DebitSu rcharge></XmlProfile></PaymentMethod>

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>310</Vendor> <Username>ex4</Username> </Result>

Example 5: InterceptD This example table shows the information needed to add a merchant using the InterceptD processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch

Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex5 123 FALSE

FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>InterceptD</ProcessorID><Pay mentTypeID>DINERS</PaymentTypeID><HostBased>True</Host Based><XmlProfile><CompanyKey>8990</CompanyKey><PIN> 1234</PIN><TerminalID>6177</TerminalID><IndustryID>E</In dustryID><CurrencyID>USD</CurrencyID><DebitSurcharge>0</ DebitSurcharge></XmlProfile></PaymentMethod>

PaymentMethodXml

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>311</Vendor> <Username>ex5</Username> </Result>

Example 6: PayTampa This example table shows the information needed to add a merchant using the PayTampa processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex6 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>PayTampa</ProcessorID><Pay mentTypeID>CARTBLANCH</PaymentTypeID><HostBased>True </HostBased><XmlProfile><MerchantNumber>700000000544</ MerchantNumber><TerminalNumber>002</TerminalNumber><Cl ientNumber>0002</ClientNumber><UserID>tpitest1</UserID>< Password>bpittman1</Password><HostBased_Manual_Settle>FA LSE</HostBased_Manual_Settle><Industry>E</Industry><Debit Surcharge>0</DebitSurcharge></XmlProfile></PaymentMethod>

PaymentMethodXml

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>312</Vendor>

<Username>ex6</Username> </Result>

Example 7: RMRS This example table shows the information needed to add a merchant using the RMRS processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex7 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>RMRS</ProcessorID><Payment TypeID>ECHECK</PaymentTypeID><HostBased>True</HostBase d><XmlProfile><VerificationPortNumber>54081</VerificationPort Number><VerificationSiteNumber>641</VerificationSiteNumber> <VerificationTerminalNumber>232993</VerificationTerminalNumb er><VerificationRuleSet>833</VerificationRuleSet><TruncationPo rtNumber>54080</TruncationPortNumber><TruncationSiteNumb er>65301</TruncationSiteNumber><TruncationTerminalNumber> 66</TruncationTerminalNumber><TruncationRuleSet>66</Trunca tionRuleSet></XmlProfile></PaymentMethod>

PaymentMethodXml

Result:

<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>313</Vendor> <Username>ex7</Username> </Result>

Example 8: VITAL This example table shows the information needed to add a merchant using the VITAL processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity

Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex8 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond

ContactSate ContactPostalCode

WA 98034 <PaymentMethod><ProcessorID>VITAL</ProcessorID><Payment TypeID>DEBIT</PaymentTypeID><HostBased>FALSE</HostBase d><XmlProfile><SSL2>True</SSL2><ConnectionMethod>SSL2< /ConnectionMethod><Processor_ID>VITAL</Processor_ID><Merc hantNumber>888000000394</MerchantNumber><TerminalNumb er>1515</TerminalNumber><AgentBankNumber>000000</Agen tBankNumber><ChainNumber>111111</ChainNumber><StoreNu mber>5999</StoreNumber><BinNumber>999995</BinNumber> <CustomerServicePhone>1231231234</CustomerServicePhone><LocationNumber>00001</Lo cationNumber><PostalCode>98052</PostalCode><CategoryCode >5999</CategoryCode><VNumber>71004021</VNumber><Indu stryID>R</IndustryID><TimezoneID>PST</TimezoneID><Curre ncyID>840</CurrencyID><CountryID>USA</CountryID><Langu ageID>00</LanguageID><InputDeviceID>2</InputDeviceID><A BANumber>111111111</ABANumber><SettlementAgentNumber >V001</SettlementAgentNumber><SharingGroup>ABC</Sharing Group><ReimbursementAttribute>Z</ReimbursementAttribute>< FCSID /><DebitSurcharge>0</DebitSurcharge></XmlProfile></Paymen tMethod>

PaymentMethodXml

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>314</Vendor> <Username>ex8</Username> </Result>

Example 9: GlobalEast This example table shows the information needed to add a merchant using the GlobalEast processor. The parameters should be changed when testing this example yourself.

Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode

Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex9 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>GlobalEast</ProcessorID><Pay mentTypeID>JAL</PaymentTypeID><HostBased>True</HostBas ed><XMLProfile><HostBased_Manual_Settle>True</HostBased_ Manual_Settle><MerchantID>3929300</MerchantID><BankID>0 95000</BankID><Key>3606</Key><IndustryID>R</IndustryID ></XMLProfile></PaymentMethod>

PaymentMethodXml

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>315</Vendor> <Username>ex9</Username>

</Result>

Example 10: RS This example table shows the information needed to add a merchant using the RS processor. The parameters should be changed when testing this example yourself.
Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode PaymentMethodXml Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex10 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>RS</ProcessorID><PaymentTyp eID>IMAGE</PaymentTypeID><HostBased>True</HostBased>< XmlProfile/></PaymentMethod>

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner />

<Vendor>316</Vendor> <Username>ex10</Username> </Result>

Example 11: Register This example table shows the information needed to add a merchant with a register using RS processor. The parameters should be changed when testing this example yourself.
Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode PaymentMethodXml Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex11 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>RS</ProcessorID><PaymentTyp eID>PAYRECEIPT</PaymentTypeID><HostBased>True</HostBas ed><XmlProfile /></PaymentMethod> <Registers><Register><RegisterName>Terminal1</RegisterNam e><RegisterNum>01</RegisterNum><DebitTerminalNum>01</D ebitTerminalNum><EBTTerminalNum>01</EBTTerminalNum></R egister></Registers>

RegistersXml

Result:
<?xml version="1.0" encoding="utf-8" ?>

- <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>317</Vendor> <Username>ex11</Username> </Result>

Example 12: Heartland Payment Systems This example table shows the information needed to add a merchant using the Heartland Payment Systems processor. The parameters should be changed when testing this example yourself.
Parameter UserName SecureToken MerchantUserName MerchantPassword AutoCloseBatch FourceDuplicate RequirePNRef ContactFirstName ContactLastName ContactEmail ContactDayPhone ContactStreet1 ContactCity ContactSate ContactPostalCode PaymentMethodXml Value Test jYizQ51MNs1wf1fcP25eB3iYRxg/u95tGvMRUhyhsIo7HlDMBhq0Lw= = ex8 123 FALSE FALSE FALSE John Doe [email protected] 555-555-5555 123 Any St Redmond WA 98034 <PaymentMethod><ProcessorID>Heartland</ProcessorID><Pay

mentTypeID>DEBIT</PaymentTypeID><HostBased>FALSE</Host Based><XmlProfile><SSL2>True</SSL2><ConnectionMethod>S SL2</ConnectionMethod><Processor_ID>Heartland</Processor_I D><MerchantNumber>888000000394</MerchantNumber><Term inalNumber>1515</TerminalNumber><AgentBankNumber>00000 0</AgentBankNumber><ChainNumber>111111</ChainNumber> <StoreNumber>5999</StoreNumber><BinNumber>999995</Bin Number><CustomerServicePhone>1231231234</CustomerServicePhone><LocationNumber>00001</Lo cationNumber><PostalCode>98052</PostalCode><CategoryCode >5999</CategoryCode><VNumber>71004021</VNumber><Indu stryID>R</IndustryID><TimezoneID>PST</TimezoneID><Curre ncyID>840</CurrencyID><CountryID>USA</CountryID><Langu ageID>00</LanguageID><InputDeviceID>2</InputDeviceID><A BANumber>111111111</ABANumber><SettlementAgentNumber >V001</SettlementAgentNumber><SharingGroup>ABC</Sharing Group><ReimbursementAttribute>Z</ReimbursementAttribute>< FCSID /><DebitSurcharge>0</DebitSurcharge></XmlProfile></Paymen tMethod>

Result:
<?xml version="1.0" encoding="utf-8" ?> - <Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tpisoft.com/Admin/ws"> <Code>OK</Code> <Error>A new Merchant was successfully created!</Error> <Partner /> <Vendor>314</Vendor> <Username>ex12</Username> </Result>
Note: When using AddMerchant to programmatically add merchant accounts, there is a requirement to run a sql script that will add the Admin HOST IP. If there were no prior entries, the SQL script to run is the statement below to add the IP of Admin Host. This will create this key in AppSetting_T table entry. INSERT INTO AppSetting_T (Application_Key, AppSetting_Key, AppSetting_Value, XmlProfile_TXT) VALUES (8, 'AdminHostIP', 'localhost|127.0.0.1', NULL) If the key was already created by running the sql statement above, you can simple update it by running this sql statement: Update AppSetting_T set AppSetting_Value = localhost|127.0.0.1|WHATEVERIPYOUWANTHERE

DeleteMerchant
This Web service operation allows you to delete a merchant. The URL to access this operation is: https://localhost/admin/ws/admin.asmx?op=DeleteMerchant. The text localhost in the URL should be replaced with the actual host name or static IP address of the payment server. Descriptions of the parameters are listed below.
Parameter UserName SecureToken Value Required. Reseller name assigned in the payment server (ex: admin) Required. The Resellers secure code given by the payment server located at the Preferences menu, under Password Required. The key of the reseller under which the merchant is deleted. This would be located at the Preference menu, under Password (ex: MSP/Partner Number: 100) Required. The key of the merchant to be deleted. Located at the Manage Merchants, under Find/Edit and search for the merchant, the ID will be in the far left column. Optional. Extended data in XML format

ResellerKey

MerchantKey ExtData

Example
The following table contains sample data you can use to test this Web service. The parameters should be changed when testing this example yourself.
Parameter UserName SecureToken ResellerKey MerchantKey Value admin iEeVzZQ8LeFS8o2HRXN097MZiaur9k1hEoLo1iYnLRPvN81t/xJoTA== 100 316

Result:
<Result> <Code>OK</Code> <Error>Merchant 316 deleted.</Error> <Partner />100</Partner>

<Vendor>316</Vendor> <Username/> </Result>

AddRecurringCreditCard
This web service operation allows you to add a customer, a contract and a credit card payment method all in one call. All parameters marked as required must be supplied.Optional parameters can be left blank and the default value will be used. Default values are empty strings for string type and 0 for integer type.The URL to access this web service is http://localhost/admin/ws/recurring.asmx?op=AddRecurringCreditCard
Parameter Username Password Vendor CustomerID Customer Name FirstName LastName Title Department Street1 Street2 Street3 City StateID Province Zip Value Required. The username of the admin user. Required. The password of the admin user Required. The numerical Vendor/Merchant Key. Required. A merchant supplied a unique indentifier for a customer. Required. The customers name is to be submitted in this field. Optional. The customers first name. Optional. The customers last name. Optional. The customers title. Optional. The customer department. Optional. The customers street address 1. Optional. The customers street address 2. Optional. The customers street adddress3. Optional. The customers city. Optional. The customers 2 character State Code Optional. The customers province if it is outside the USA Optional. The customers zip code if in the USA, postal code if outside the USA Optional. The customers 3 character country code, for example, USA or CAN

CountryID

Email Mobile ContractID ContractName BillAmt TaxAmt TotalAmt StartDate

Optional. The customers email address. Optional. The customers mobile phone. Required. The merchant supplied unique indentifier for the contract. Optional. The contracts name. Required. The amount to be billed in relation to the contract. Optional. The tax amount. Required. This is the total amount. BillAmt + TaxAmt = TotalAmt. Required. The start date of the contract. Optional. The end date of the contract. If this date is not given, the contract

EndDate

will continue to run until manually cancelled

or suspended by the system

due to failure of payment

BillingPeriod Required. Specifies the Billing Period Type, used in conjunction with BillingInterval to compute the next bill date. Required. Depending on the billing period, it can mean different things such as DAY = every X number of days, BillingInterval WEEK = number of times per week, MONTH = number fo times per month; YEAR = number of times per year. 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. Optional. Number of days the system will wait after each payment retry when the payment fails. Optional. TRUE/FALSE setting whether to email the customer regarding the status of the recurring payment. Optional. TRUE/FALSE setting whether to email the merchant regarding the status of recurring payment.

MaxFailures

FailureInterval

EmailCustomer

EmailMerchant

EmailCustomerFailure Optional. TRUE/FALSE setting whether to email the customer when the recurring payment fails. EmailMerchantFailure CcAccountNum Optional. TRUE/FALSE setting whether to email the merchant when the recurring payemt fails. Required. The customers credit card number.

CcExpdate CcNameOnCard CcStreet CcZip

Required. The credit card expiration date. Optional. The Card Holders name as it is on the card. Optional. The Card Holders billing address Optional. The Card Holders billing zip code. Optional. Extended Data.

ExtData

Example

Response
<?xml version="1.0" encoding="utf-8" ?> - <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>

AddRecurringCheck
This web service allows for adding a customer, a contract and a credit card payment method all in one call.All parameters marked as required must be supplied. Optional parameters can be left blank and the default value will be used.Default values are as follows, empty string for string type and 0 for integer. The URL to access this web service is: http://localhost/admin/ws/recurring.asmx?op=AddRecurringCheck
Parameter Username Password Vendor CustomerID Value Required. The username of the admin user. Required. The password of the admin user Required. The numerical Vendor/Merchant Key. Required. A merchant supplied a unique indentifier for a customer.

Customer Name FirstName LastName Title Department Street1 Street2 Street3 City StateID Province Zip

Required. The customers name is to be submitted in this field. Optional. The customers first name. Optional. The customers last name. Optional. The customers title. Optional. The customer department. Optional. The customers street address 1. Optional. The customers street address 2. Optional. The customers street adddress3. Optional. The customers city. Optional. The customers 2 character State Code Optional. The customers province if it is outside the USA Optional. The customers zip code if in the USA, postal code if outside the USA Optional. The customers 3 character country code, for example, USA or CAN Optional. The customers email address. Optional. The customers mobile phone. Required. The merchant supplied unique indentifier for the contract. Optional. The contracts name. Optional. The amount to be billed in relation to the contract. Optional. The tax amount. Required. This is the total amount. BillAmt + TaxAmt = TotalAmt. Required. The start date of the contract. Optional. The end date of the contract. If this date is not given, the contract

CountryID Email Mobile ContractID ContractName BillAmt TaxAmt TotalAmt StartDate

EndDate

will continue to run until manually cancelled

or suspended by the system

due to failure of payment

BillingPeriod Required. Specifies the Billing Period Type, used in conjunction with BillingInterval to compute the next bill date. Required. Depending on the billing period, it can mean different things such as DAY = every X number of days,

BillingInterval

WEEK = number of times per week, MONTH = number fo times per month; YEAR = number of times per year. 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. Optional. Number of days the system will wait after each payment retry when the payment fails. Optional. TRUE/FALSE setting whether to email the customer regarding the status of the recurring payment. Optional. TRUE/FALSE setting whether to email the merchant regarding the status of recurring payment.

MaxFailures

FailureInterval

EmailCustomer

EmailMerchant

EmailCustomerFailure Optional. TRUE/FALSE setting whether to email the customer when the recurring payment fails. EmailMerchantFailure CheckType AccountType CheckNum MICR AccountNum TransitNum SS DOB BranchCity DL StateCode NameOnCheck ExtData Optional. TRUE/FALSE setting whether to email the merchant when the recurring payemt fails. Required. Two types of checks whether PERSONAL or BUSINESS. Required. Two types of account whether CHECKING or SAVINGS. Optional. This is the check number. Optional. This is the scanned MICR data of the check. Required. This is the account number. Required. This is the transit number. Optional. Social Security number of the check holder. Optional. Date of Birth of the check holder. Optional. The city of the bank where the branch is located. Optional. The drivers license number of the check holder Optional. The 2 character State Code of the drivers License of the check holder. Optional. The check holders name as it is on the check.

Optional. Extended Data.

Example

Response

<?xml version="1.0" encoding="utf-8" ?>

- <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>12</CustomerKey> <ContractKey>8</ContractKey> <CcInfoKey /> <CheckInfoKey>3</CheckInfoKey> <code>OK</code> <error>OK</error> <Partner>100</Partner> <Vendor>41</Vendor> <Username>ncn1</Username> </RecurringResult>

ProcessCreditCard - Recurrring Billing

This web service operation processes credit card transactions within the recurring billing module. The URL to access this web service is: http://localhost/admin/ws/recurring.asmx?op=ProcessCreditCard
Parameter Username Password Vendor CcInfoKey Amount InvNum ExtData Value Required. The username of the admin user. Required. The password of the admin user Required. The numerical Vendor/Merchant Key. Required. The numerical Credit Card Info key. Required. The amount that will be processed for that transaction. Optional. The associated invoice number. Optional. Extended Data.

Example

Response:
<?xml version="1.0" encoding="utf-8" ?> - <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"> <code>OK</code> <error>APPROVED</error> <Result>0</Result> <AuthCode>TAS351</AuthCode> <PNRef>26873</PNRef> <Message>NO MATCH</Message> </RecurringResult>

ProcessCheck Recurring Billing

This web service operation allows for the processing of check transactions within the recurring billing module. The URL to access this Web Service is: http://localhost/admin/ws/recurring.asmx?op=ProcessCheck
Parameter Username Password Vendor CheckInfoKey Amount InvNum ExtData Value Required. The username of the admin user. Required. The password of the admin user Required. The numerical Vendor/Merchant Key. Required. The numerical Check Payment Info key. Required. The amount that will be processed for that transaction. Optional. The associated invoice number. Optional. Extended Data.

Example

Response
<?xml version="1.0" encoding="utf-8" ?> - <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"> <code>OK</code>

<error>APPROVED</error> <Result>0</Result> <AuthCode>AUTH NUM 674-564</AuthCode> <PNRef>26945</PNRef> <Message>APPROVAL</Message> </RecurringResult>

ManageCheckInfo
This Web Service operation allows for managing check information .The URL to access this Web Service is: http://localhost/admin/ws/recurring.asmx?op=ManageCheckInfo
Parameter Username Password Vendor CustomerKey CheckInfoKey CheckType AccountType CheckNum MICR AccountNum TransitNum SS DOB BranchCity DL StateCode NameOnCheck Email Value Required. The username of the admin user. Required. The password of the admin user Required. The numerical Vendor/Merchant Key. Required. The numerical customer key. Required for TransType UPDATE and DELETE. The numerical Customer Key Required. Two types of checks whether PERSONAL or BUSINESS. Required. Two types of account whether CHECKING or SAVINGS. Optional. This is the check number. Optional. This is the scanned MICR data of the check. Required. This is the account number. Required. This is the transit number. Optional. Social Security number of the check holder. Optional. Date of Birth of the check holder. Optional. The city of the bank where the branch is located. Optional. The drivers license number of the check holder Optiional. The 2 character State Code of the drivers license of the check holder, e.g. NY or GA Optional. The check holders name as it is on the check. Optional. The customers email address.

DayPhone Street1 Street2 Street3 City StateID Province PostalCode CountryID ExtData

Optional. The customers day phone. Optional. The customers street address 1. Optional. The customers street address 2. Optional. The customers street adddress3. Optional. The customers city. Optional. The customers 2 character State Code Optional. The customers province if it is outside the USA Optional. The customers zip code if in USA , postal code if outside USA Optional. The customers 3 character country code, for example, USA or CAN

Optional. Extended Data.

Example

Response
<?xml version="1.0" encoding="utf-8" ?> - <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>12</CustomerKey> <ContractKey /> <CcInfoKey />

<CheckInfoKey>4</CheckInfoKey> <code>OK</code> <error>OK</error> <Partner>100</Partner> <Vendor>41</Vendor> <Username>ncn1</Username> </RecurringResult>

ManageCreditCardInfo
This Web Service allows for managing the credit card information. The URL for accessing this Web Service is at: http://localhost/admin/ws/recurring.asmx?op=ManageCreditCardInfo
Parameter Username Password Value Required. The username of the admin user. Required. The password of the admin user Required. The type of transaction being performed. Valid values are: TransType ADD UPDATE DELETE Vendor CustomerKey CardInfoKey CcAccountNum CcExpDate CcNameonCard CcStreet CcZip ExtData Required. The numerical Vendor/Merchant Key. Required. The numerical Customer Key. Required. The numerical credit card info key. Required. The credit card account number. Required. The credit card expiration date. Optional. The name of the card holder Optional. The card holders billing address. Optional. The card holders billing zip code. Optional. Extended Data.

Example

Response
<?xml version="1.0" encoding="utf-8" ?> - <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 /> <CcInfoKey>26674</CcInfoKey> <CheckInfoKey /> <code>OK</code> <error>OK</error>

<Partner>100</Partner> <Vendor>1</Vendor> <Username>vital</Username> </RecurringResult>

ManageContract
This web service allows for managing different properties of contracts via integration. This can be accessed by using this URL: http://localhost/admin/ws/recurring.asmx?op=ManageContract
Parameter Username Password Value Required. The username of the admin user. Required. The password of the admin user Required. The type of transaction being performed. The valid values are: TransType ADD UPDATE DELETE Vendor CustomerKey ContractKey PaymentInfoKey Required. The numerical Vendor/Merchant Key. Required. The numerical customer key. Required for TransType UPDATE and DELETE. The numerical contract key.
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.

Required for TransType ADD and UPDATE. Type of payment: PaymentType CC for Credit Card and CK for Check CustomerID Customer Name FirstName LastName Title Department Required. A merchant supplied a unique indentifier for a customer. Required. The customers name is to be submitted in this field. Optional. The customers first name. Optional. The customers last name. Optional. The customers title. Optional. The customer department.

Street1 Street2 Street3 City StateID Province Zip

Optional. The customers street address 1. Optional. The customers street address 2. Optional. The customers street adddress3. Optional. The customers city. Optional. The customers 2 character State Code Optional. The customers province if it is outside the USA Optional. The customers zip code if in the USA, postal code if outside the USA Optional. The customers 3 character country code, for example, USA or CAN Optional. The customers day phone. Optional.The customers evening phone. Optional. The customers fax number. Optional. The customers email address. Optional. The customers mobile phone. Required. The merchant supplied unique indentifier for the contract. Optional. The contracts name. Optional. The amount to be billed in relation to the contract. Optional. The tax amount. Required. This is the total amount. BillAmt + TaxAmt = TotalAmt. Required. The start date of the contract. Optional. The end date of the contract. If this date is not given, the contract

CountryID DayPhone NightPhone Fax Email Mobile ContractID ContractName BillAmt TaxAmt TotalAmt StartDate

EndDate

will continue to run until manually cancelled

or suspended by the system

due to failure of payment

NextBillDt BillingPeriod BillingInterval Required. This is required for TRANSTYPE ADD and UPDATE. Required. Specifies the Billing Period Type, used in conjunction with BillingInterval to compute the next bill date. 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. 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. Optional. Number of days the system will wait after each payment retry when the payment fails. Optional. TRUE/FALSE setting whether to email the customer regarding the status of the recurring payment. Optional. TRUE/FALSE setting whether to email the merchant regarding the status of recurring payment.

MaxFailures

FailureInterval

EmailCustomer

EmailMerchant

EmailCustomerFailure Optional. TRUE/FALSE setting whether to email the customer when the recurring payment fails. EmailMerchantFailure Status ExtData Optional. TRUE/FALSE setting whether to email the merchant when the recurring payemt fails. Optional. Status of the contract.

Optional. Extended Data.

Example

<?xml version="1.0" encoding="utf-8" ?> - <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>

ManageCustomer
This webservice allows for the management of customer information. This web service can be accessed by this url: http://savqaps/admin/ws/recurring.asmx?op=ManageCustomer
Parameter Username Password Value Required. The username of the admin user. Required. The password of the admin user Required. The type of transaction being performed. The valid values are: TransType ADD UPDATE DELETE Vendor CustomerKey CustomerID Customer Name FirstName LastName Title Department Street1 Street2 Street3 City StateID Province Zip Required. The numerical Vendor/Merchant Key. Required. The numerical customer key. Required. A merchant supplied a unique indentifier for a customer. Required. The customers name is to be submitted in this field. Optional. The customers first name. Optional. The customers last name. Optional. The customers title. Optional. The customer department. Optional. The customers street address 1. Optional. The customers street address 2. Optional. The customers street adddress3. Optional. The customers city. Optional. The customers 2 character State Code Optional. The customers province if it is outside the USA Optional. The customers zip code if in the USA, postal code if outside the USA Optional. The customers 3 character country code, for example, USA or CAN Optional. The customers day phone. Optional.The customers evening phone.

CountryID DayPhone NightPhone

Fax Email Mobile Status ExtData

Optional. The customers fax number. Optional. The customers email address. Optional. The customers mobile phone. Optional. Status of the contract.

Optional. Extended Data.

Example

Response
<?xml version="1.0" encoding="utf-8" ?> - <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> <code>OK</code> <error>OK</error> <Partner /> <Vendor>1</Vendor> <Username>vital</Username> </RecurringResult>

ManageContractAddDaysToNextBillDt
This web service allows for adding days to the next billing date and it can be accessed by this URL: http://localhost/admin/ws/recurring.asmx?op=ManageContractAddDaysToNextBillDt
Parameter Username Password Vendor CustomerKey ContractKey NumOfDays ExtData Value Required. The username of the admin user. Required. The password of the admin user Required. The numerical Vendor/Merchant Key. Required. The numerical customer key. Required for TransType UPDATE and DELETE. The numerical contract key. The number of days to be added. Optional. Extended Data.

Example

Response
<?xml version="1.0" encoding="utf-8" ?> - <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 /> <CheckInfoKey /> <code>OK</code> <error>NextBillDate=2/28/2007</error> <Partner /> <Vendor /> <Username>vital</Username> </RecurringResult>

GetNetworkID
This web service allows for returning the debit network ID if the debit card number matches any of these networks bin ranges. If there is a match, the card can likely be used as a debit card and processed through the Debit Network.This BIN range is stored in %EPSROOT%\xmlfiles\CardBin.txt which needs to be periodically updated MANUALLY probably every month or so. This web service can be accessed through this URL: http:/localhost/smartpayments/validate.asmx?op=GetNetworkID Note: This was tested with a live Debit card number.

Example
Parameter Username Password CardNumber Value Required. The username of the admin user. Required. The password of the admin user Required. The customers debit card number.

Sample: http://www.tpisoft.com/smartpayments/validate.asmx?op=GetNetworkID
POST /smartpayments/validate.asmx/GetNetworkID HTTP/1.1

Host: www.tpisoft.com Content-Type: application/x-www-form-urlencoded Content-Length: length

UserName=string&Password=string&CardNumber=string

Response
<?xml version="1.0" encoding="utf-8" ?> - <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://localhost/SmartPayments/"> <Result>0</Result> <RespMSG>Interlink</RespMSG> <Message>Y</Message> <Message1>NetworkID=ILK,NetworkAuthorizerNum=48</Message1> <Message2>OfflineSupported=True</Message2> <AuthCode>ILK</AuthCode> <HostCode>48</HostCode> </Response>

BIN Management Network Table Values

Debit Network Network ID Network Authorization

Number Accel AFFN Alaska Option CU24 Interlink Jeanie Star Northeast (MAC) Maestro Nets NYCE Pulse Star Southeast Shazam Star West TYME ACL AFN AKO C24 ILK JEN MAC MAE NET NYC PUL SES SHZ STX TYM 69 68 61 85 48 86 17 40 83 28 06 07 58 23 78

Web Service Response Field

Transact.asmx
Response Field Data Type A string value up to 50 characters Value Description Returns the transaction result code from the payment processor Returns extra data from the processed transaction ExtData A string value up to 500 characters Remarks This value can be either an approval code, for approved transactions, or an error code, for declined transactions The value of ExtData will be in a specific format. The format typically consists of the name of the data field, an equal sign, and then the value for the data field. Multiple data fields are separated with a comma. See the Web Service ExtData Response Field Data Elements for full description of data elements that can be returned. The following is an example of the format:

AuthCode

ExtName1=ExtValue1,ExtName2=ExtValue2 A string value up to 1 character A string value up to 25 characters Returns the overall address verification result code from the payment processor Returns the formatted response message when address verification is performed Returns the payment processor's response indicator that specifies if the card is a commercial card When programmatically validating an AVS Result, this value should ALWAYS be used instead of any formatted response message describing the result Do NOT use this when programmatically validating a transactions AVS result; please see GetAVSResult field

GetAVSResult

GetAVS ResultTXT

Get CommercialCard

A string value representing a Boolean value

This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result This value is only applicable to credit card transactions. Do NOT use this when programmatically validating a transactions CV result; please see GetCVResult field This value will typically be Match, for correctly matching the street address, or No Match, for an incorrect street address This value will typically be Match, for correctly matching the zip code, or No Match, for an incorrect zip code This value may not be returned for all payment processors

GetCVResult

A string value up to 1 character

Returns the card verification result code from the payment processor

GetCVResultTXT

A string value up to 25 characters A string value up to 25 characters A string value up to 25 characters A string value up to 30 characters

Returns the formatted response message when card verification is performed Returns the formatted response message when street number address verification is performed Returns the formatted response message when zip code address verification is performed Typically returns a number which uniquely identifies the transaction in the payment processor Returns a formatted response message concerning the processed transaction Returns an extra formatted response message giving more information about the processed transaction

GetStreetMatchTXT

GetZipMatchTXT

HostCode

Message

A string value up to 50 characters

This value will typically be APPROVAL, for approved transactions, or an error message, for declined transactions. Do NOT use this when programmatically validating a transactions result; please see Result field below The Payment Server will only populate this field when there is applicable information from the payment processor to return

Message1

A string value up to 50 characters

Message2

A string value up to 50 characters A string value representing a signed 32-bit integer A string value up to 50 characters

Returns an extra formatted response message giving more information about the processed transaction Returns a number which uniquely identifies the transaction in the payment gateway Returns the response message concerning the processed transaction Returns the transaction result code from the payment gateway which signifies the result of the transaction (i.e. approved, decline, etc.)

The Payment Server will only populate this field when there is applicable information from the payment processor to return

PNRef

RespMSG

This value is typically either Approved or Declined. Do NOT use this when programmatically validating a transactions result; please see Result field below When programmatically validating a transactions result, this value should ALWAYS be used instead of any response message describing the result. See the Result Response Fields Definitions section for a full list of result values and descriptions

Result

A string value representing a signed 32-bit integer

Transact.asmx Web Service ExtData Response Field Data Elements

Data Element Name BatchNum Value Description Returns the current batch number, returned by the payment processor, for transactions, settlement, and batch inquiries Returns the credit card type (VISA, MASTERCARD, etc), payment method (Debit, EBT, or EGC) for cardbased payments Returns the same invoice number for the transaction that was originally sent in the request to the Payment Server Remarks Not all payment processors support returning this data element This value is not returned for Check/ACH payments

CardType

InvNum

TrxDetail.asmx
Response Field Account_Type_CH Data Type A string value up to 10 characters Value Description Returns the card type of the transaction, e.g. VISA, Diners, EBT Returns the check account number This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Remarks

AccountNum_VC

A string value up to 200 characters

Security Level of the user is set to 1 Returns credit card number Acct_Num_CH A string value up to 200 characters This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Security Level of the user is set to 1

Amount_MN

A string value representing a signed 64-bit real number A string value up to 50 characters A string value representing a signed 64-bit real number A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer

Returns the checks total amount Returns the response code from the payment processor Returns the authorized amount of a card transaction Returns the dollar amount of all Authorization (PreAuth) transactions Returns the transaction count of all Authorization (PreAuth) transactions Returns the address verification result code from the payment processor Returns the formatted response message when address verification is performed Returns the batch number for the transaction that was returned by the payment processor Returns the dollar amount of all Capture transactions Returns the transaction count of all Capture transactions Returns the primary key of the CC_Info_T table in the database Returns the cash back amount for a debit or EBT transaction Not all payment processors support returning this data element This value will always return 0 This value will always return 0

Approval_Code_CH

Auth_Amt_MN

Authorization

Authorization_Cnt

AVS_Resp_CH

A string value up to 1 character

AVS_Resp_Txt_VC

A string value up to 25 characters

Batch_Number

A string value up to 10 characters

Capture

A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer A string value representing a signed 32-bit integer A string value representing a signed 64-bit real number

Capture_Cnt

Card_Info_Key

Cash_Back_Amt_MN

CheckNum_CH

A string value up to 10 characters A string value representing a signed 32-bit integer A string value up to 50 characters

Returns the check number Returns the transaction count of all transactions Returns the Customer ID of a customer to which the transaction belongs to Returns the card verification result code from the payment processor Returns the formatted response message when card verification is performed Returns the date on which the transaction is first made Returns an error message when a problem occurs during the transaction processing Returns the credit card expiration date Returns the dollar amount of all ForceCapture (ForceAuth) transactions Returns the transaction count of all ForceCapture (ForceAuth) transactions Returns the payment processors date on which the transaction is performed Returns a number which uniquely identifies the transaction for the payment processor Returns the payment processors time at which the transaction was performed Returns the

Cnt

CustomerID

CV_Resp_CH

A string value up to 1 character

CV_Resp_Txt_VC

A string value up to 25 characters A string value representing a date and time

Date_DT

ERROR

A string value up to 200 characters

Exp_CH

A string value up to 10 characters A string value representing a signed 64-bit real number

ForceCapture

ForceCapture_Cnt

A string value representing a signed 32-bit integer

Host_Date_CH

A string value up to 10 characters

Host_Ref_Num_CH

A string value up to 30 characters

Host_Time_CH

A string value up to 10 characters A string value up to 100

Invoice_ID

characters

transactions Invoice number Returns the IP address of the client machine from which the transaction was processed Returns the date and time on which the transaction is last modified Returns the card was swiped or not Returns a number which uniquely identifies a merchant Returns the name of the cardholder Returns the check payers name on the check Returns the TRX_HD_Key on which the current transaction is based Returns the payment type, e.g. ECHECK Returns the dollar amount of all PostAuth transactions Returns the transaction count of all PostAuth transactions Returns the name the payment processor, e.g. Vital Returns the dollar amount of all transactions with a Receipt Returns the transaction count of all transactions with a Receipt Not currently used This value will always return 0

IP_VC

A string value up to 15 characters

Last_Update_DT

A string value representing a date and time A string value representing a Boolean value A string value representing a signed 32-bit integer A string value up to 25 characters A string value up to 25 characters A string value representing a signed 32-bit integer A string value up to 10 characters A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer A string value up to 10 characters A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer

Manual

Merchant_Key

Name_on_Card_VC

NameOnCheck_VC

Orig_TRX_HD_Key

Payment_Type_ID

PostAuth

PostAuth_Cnt

Processor_ID

Receipt

Receipt_Cnt

This value will always return 0 This field is not the unique transaction identifier (also called PNRef) of the Payment Server. See the field TRX_HD_Key for the

Ref_Number_CH

A string

PNRef value Register_Number_CH A string value up to 10 characters A string value representing a signed 64-bit real number Returns the register number of a transaction Returns the dollar amount of all RepeatSale (Recurring Billing/Installment) transactions Returns the transaction count of all RepeatSale (Recurring Billing/Installment) transactions Returns the primary key of the Reseller_T table in the database Returns the transaction processing result, e.g. 0, 12. 0 for approval, 12 for decline Returns the check transactions processing result Returns an extra formatted response message giving more information about the processed transaction Returns an extra formatted response message giving more information about the processed transaction Returns the text message of either approval or decline for the transaction processing result Returns the dollar amount of all Return (Credit) transactions Returns the transaction count of all Return (Credit) transactions Returns the dollar amount of all Sale transactions Returns the transaction count of all Sale transactions

RepeatSale

RepeatSale_Cnt

A string value representing a signed 32-bit integer A string value representing a signed 32-bit integer A string value up to 50 characters

Reseller_Key

Result_CH

Result_Msg_VC

A string value up to 50 characters

Result_Msg1_VC

A string value up to 50 characters

Result_Msg2_VC

A string value up to 50 characters

Result_Txt_VC

A string value up to 150 characters

Return

A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer

Return_Cnt

Sale

Sale_Cnt

Settle_Date_DT

A string value representing a date and time A string value representing a Boolean value A string value up to 10 characters A string value up to 25 characters A string value representing a signed 64-bit real number A string value representing a signed 64-bit real number A string value up to 20 characters A string

Returns the date on which the transaction is settled Returns if the transaction is settled or not Returns the state code Returns the billing street address of the credit card Returns the sure charge amount of a transaction Returns the tip amount of a transaction Returns the transaction type, e.g. Sale, Credit Returns the Transportation Method Returns the Transportations Ending Destination Returns the transit/routing number Only for use with Dialup transactions Only for use with Dialup transactions This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Security Level of the user is set to 1

Settle_Flag_CH

StateCode_CH

Street_CH

SureCharge_Amt_MN

Tip_Amt_MN

Trans_Type_ID Transport_Method

Transport_EndPoint

A string

TransitNum_VC

A string value up to 200 characters

TRX_Card_Key

A string value representing a signed 32-bit integer A string value representing a signed 32-bit integer

Returns the primary key of the TRX_Card_T table in the database Returns the primary key of the TRX_Check_T table in the database Returns the primary key This field is the unique of the TRX_Header_T transaction identifier table in the database (also called PNRef) of the Payment Server. Use its value when submitting transactions based on a previous transaction (i.e. Voids) through the Transact.asmx Web Service Returns the primary key of the TRX_Settle_T table in the database

TRX_Check_Key

TRX_HD_Key

A string value representing a signed 32-bit integer

TRX_Settle_Key

A string value representing a signed 32-bit integer

TRX_Settle_Msg_VC

A string value up to 25 characters A string value up to 10 characters A string value up to 25 characters A string value representing a Boolean value A string value up to 10 characters A string value representing a signed 64-bit real number A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer

Returns the transactions settlement message Returns the credit card type, e.g. VISA, MASTERCARD Returns the username, under which the transactions were made Returns the transaction is voided or not Returns the billing zip code of the credit card Returns the authorized amount of a card transaction Returns the dollar amount of all Authorization (PreAuth) transactions Returns the transaction count of all Authorization (PreAuth) transactions Returns the address verification result code from the payment processor Returns the formatted response message when address verification is performed Returns the batch number for the transaction that was returned by the payment processor Returns the dollar amount of all Capture transactions Returns the transaction count of all Capture transactions Returns the primary key of the CC_Info_T table in the database Returns the cash back amount for a debit or EBT transaction Not all payment processors support returning this data element This value will always return 0 This value will always return 0

Type_CH

User_Name_VC

Void_Flag_CH

Zip_CH

Auth_Amt_MN

Authorization

Authorization_Cnt

AVS_Resp_CH

A string value up to 1 character

AVS_Resp_Txt_VC

A string value up to 25 characters

Batch_Number

A string value up to 10 characters

Capture

A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer A string value representing a signed 32-bit integer A string value representing a signed 64-bit real number

Capture_Cnt

Card_Info_Key

Cash_Back_Amt_MN

CheckNum_CH

A string value up to 10 characters A string value representing a signed 32-bit integer A string value up to 50 characters

Returns the check number Returns the transaction count of all transactions Returns the Customer ID of a customer to which the transaction belongs to Returns the card verification result code from the payment processor Returns the formatted response message when card verification is performed Returns the date on which the transaction is first made Returns an error message when a problem occurs during the transaction processing Returns the credit card expiration date Returns the dollar amount of all ForceCapture (ForceAuth) transactions Returns the transaction count of all ForceCapture (ForceAuth) transactions Returns the payment processors date on which the transaction is performed Returns a number which uniquely identifies the transaction for the payment processor Returns the payment processors time at which the transaction was performed Returns the

Cnt

CustomerID

CV_Resp_CH

A string value up to 1 character

CV_Resp_Txt_VC

A string value up to 25 characters A string value representing a date and time

Date_DT

ERROR

A string value up to 200 characters

Exp_CH

A string value up to 10 characters A string value representing a signed 64-bit real number

ForceCapture

ForceCapture_Cnt

A string value representing a signed 32-bit integer

Host_Date_CH

A string value up to 10 characters

Host_Ref_Num_CH

A string value up to 30 characters

Host_Time_CH

A string value up to 10 characters A string value up to 100

Invoice_ID

characters

transactions Invoice number Returns the IP address of the client machine from which the transaction was processed Returns the date and time on which the transaction is last modified Returns the card was swiped or not Returns a number which uniquely identifies a merchant Returns the name of the cardholder Returns the check payers name on the check Returns the TRX_HD_Key on which the current transaction is based Returns the payment type, e.g. ECHECK Returns the dollar amount of all PostAuth transactions Returns the transaction count of all PostAuth transactions Returns the name the payment processor, e.g. Vital Returns the dollar amount of all transactions with a Receipt Returns the transaction count of all transactions with a Receipt Not currently used This value will always return 0

IP_VC

A string value up to 15 characters

Last_Update_DT

A string value representing a date and time A string value representing a Boolean value A string value representing a signed 32-bit integer A string value up to 25 characters A string value up to 25 characters A string value representing a signed 32-bit integer A string value up to 10 characters A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer A string value up to 10 characters A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer

Manual

Merchant_Key

Name_on_Card_VC

NameOnCheck_VC

Orig_TRX_HD_Key

Payment_Type_ID

PostAuth

PostAuth_Cnt

Processor_ID

Receipt

Receipt_Cnt

This value will always return 0 This field is not the unique transaction identifier (also called PNRef) of the Payment Server. See the field TRX_HD_Key for the

Ref_Number_CH

A string

PNRef value Register_Number_CH A string value up to 10 characters A string value representing a signed 64-bit real number Returns the register number of a transaction Returns the dollar amount of all RepeatSale (Recurring Billing/Installment) transactions Returns the transaction count of all RepeatSale (Recurring Billing/Installment) transactions Returns the primary key of the Reseller_T table in the database Returns the transaction processing result, e.g. 0, 12. 0 for approval, 12 for decline Returns the check transactions processing result Returns an extra formatted response message giving more information about the processed transaction Returns an extra formatted response message giving more information about the processed transaction Returns the text message of either approval or decline for the transaction processing result Returns the dollar amount of all Return (Credit) transactions Returns the transaction count of all Return (Credit) transactions Returns the dollar amount of all Sale transactions Returns the transaction count of all Sale transactions

RepeatSale

RepeatSale_Cnt

A string value representing a signed 32-bit integer A string value representing a signed 32-bit integer A string value up to 50 characters

Reseller_Key

Result_CH

Result_Msg_VC

A string value up to 50 characters

Result_Msg1_VC

A string value up to 50 characters

Result_Msg2_VC

A string value up to 50 characters

Result_Txt_VC

A string value up to 150 characters

Return

A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer A string value representing a signed 64-bit real number A string value representing a signed 32-bit integer

Return_Cnt

Sale

Sale_Cnt

Settle_Date_DT

A string value representing a date and time A string value representing a Boolean value A string value up to 10 characters A string value up to 25 characters A string value representing a signed 64-bit real number A string value representing a signed 64-bit real number A string value representing a signed 64-bit real number A string value up to 20 characters A string

Returns the date on which the transaction is settled Returns if the transaction is settled or not Returns the state code Returns the billing street address of the credit card Returns the sure charge amount of a transaction Returns the tip amount of a transaction Returns the total amount of a transaction Returns the transaction type, e.g. Sale, Credit Returns the Transportation Method Returns the Transportations Ending Destination Returns the transit/routing number Only for use with Dialup transactions Only for use with Dialup transactions This field will be masked out with asterisk (*) characters except for the last 4 digits if the System Security Level of the user is set to 1

Settle_Flag_CH

StateCode_CH

Street_CH

SureCharge_Amt_MN

Tip_Amt_MN

Total_Amt_MN

Trans_Type_ID Transport_Method

Transport_EndPoint

A string

TransitNum_VC

A string value up to 200 characters

TRX_Card_Key

A string value representing a signed 32-bit integer A string value representing a signed 32-bit integer

Returns the primary key of the TRX_Card_T table in the database Returns the primary key of the TRX_Check_T table in the database Returns the primary key This field is the unique of the TRX_Header_T transaction identifier table in the database (also called PNRef) of the Payment Server. Use its value when submitting transactions based on a previous transaction (i.e. Voids) through the Transact.asmx Web Service

TRX_Check_Key

TRX_HD_Key

A string value representing a signed 32-bit integer

TRX_Settle_Key

A string value representing a signed 32-bit integer A string value up to 25 characters A string value up to 10 characters A string value up to 25 characters A string value representing a Boolean value A string value up to 10 characters

Returns the primary key of the TRX_Settle_T table in the database Returns the transactions settlement message Returns the credit card type, e.g. VISA, MASTERCARD Returns the username, under which the transactions were made Returns the transaction is voided or not Returns the billing zip code of the credit card

TRX_Settle_Msg_VC

Type_CH

User_Name_VC

Void_Flag_CH

Zip_CH

Response Values
Result Response Field Definitions (Error Codes)
The list below contains result codes returned in the Result response field of the XMLPayResponse when using a transaction processing Transact.asmx web service operation (i.e. ProcessCreditCard, ProcessCheck, etc). A decline returned by the payment processor for this response field is value twelve (12) or thirteen (13). An approval is value zero (0). Any other value is an error code, which is returned by the payment gateway and not by the payment processor. Please note that when programmatically validating a transactions result, this value should be used instead of any response message describing the result. I.e. do not use RespMSG or Message response fields, as these values may vary. Please note that this list is subject to change without prior notice.
Value -100 0 1 2 3 4 Description Transaction NOT Processed; Generic Host Error Approved User Authentication Failed Invalid Transaction Invalid Transaction Type Invalid Amount

5 7 8 9 10 11 12 13 14 19 20 22 23 24 25 26 27 28 29 30 40 50 99 100 101 102 103 104 105 106 107

Invalid Merchant Information Field Format Error Not a Transaction Server Invalid Parameter Stream Too Many Line Items Client Timeout Waiting for Response Decline Referral Transaction Type Not Supported In This Version Original Transaction ID Not Found Customer Reference Number Not Found Invalid ABA Number Invalid Account Number Invalid Expiration Date Transaction Type Not Supported by Host Invalid Reference Number Invalid Receipt Information Invalid Check Holder Name Invalid Check Number Check DL Verification Requires DL State Transaction did not connect (to NCN because SecureNCIS is not running on the web server) Insufficient Funds Available General Error Invalid Transaction Returned from Host Timeout Value too Small or Invalid Time Out Value Processor Not Available Error Reading Response from Host Timeout waiting for Processor Response Credit Error Host Not Available Duplicate Suppression Timeout

108 109 110 111 112 113 1000 1001 1002 1003 1004 1005 1006 1007 1008 1010 1011 1012 1013 1014 1015

Void Error Timeout Waiting for Host Response Duplicate Transaction Capture Error Failed AVS Check Cannot Exceed Sales Cap Generic Host Error Invalid Login Insufficient Privilege or Invalid Amount Invalid Login Blocked Invalid Login Deactivated Transaction Type Not Allowed Unsupported Processor Invalid Request Message Invalid Version Payment Type Not Supported Error Starting Transaction Error Finishing Transaction Error Checking Duplicate No Records To Settle (in the current batch) No Records To Process (in the current batch)

AVS Response Codes

The following table contains the possible response values returned for address verification (AVS).
Value X Y Description Exact: Address and nine-digit Zip match Yes: Address and five-digit Zip match

A Z W N U G R E S B C D I M P 0 5

Address: Address matches, Zip does not 5-digit Zip: 5-digit Zip matches, address doesnt Whole Zip: 9-digit Zip matches, address doesnt No: Neither address nor Zip matches Unavailable: Address information not available Unavailable: Address information not available for international transaction Retry: System unavailable or time-out Error: Transaction unintelligible for AVS or edit error found in the message that prevents AVS from being performed Not Supported: Issuer doesnt support AVS service * Street Match: Street addresses match for international transaction, but postal code doesnt * Street Address: Street addresses and postal code not verified for international transaction * Match: Street addresses and postal codes match for international transaction * Not Verified: Address Information not verified for International transaction * Match: Street addresses and postal codes match for international transaction * Postal Match: Postal codes match for international transaction, but street address doesnt ** No response sent Invalid AVS response

* These values are Visa specific. ** These values are returned by the Payment Server and not the processor.

CV Response Codes
The following table contains the possible response values returned for a CVV2/CVC2/CID check.
Value M N P Description CVV2/CVC2/CID Match CVV2/CVC2/CID No Match Not Processed

S U X

Issuer indicates that the CV data should be present on the card, but the merchant has indicated that the CV data is not present on the card. Unknown / Issuer has not certified for CV or issuer has not provided Visa/MasterCard with the CV encryption keys. Server Provider did not respond

Valid Parameter Input Characters

The table below displays all allowable characters (unless otherwise noted) that are accepted by the Payment Server. Characters are displayed in Courier New font. All other characters may cause undesirable results.

Table 1. Valid Data Characters

DEC 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 HEX 20 21 22 23 24 25 26 27 28 29 2A 2B 2C 2D 2E 2F 30 31 32 33 34 35 36 37 38 39 3A Character Space ! " # $ % & ' ( ) * + , . / 0 1 2 3 4 5 6 7 8 9 : DEC 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 HEX 3F 40 41 42 43 44 45 46 47 48 49 4A 4B 4C 4D 4E 4F 50 51 52 53 54 55 56 57 58 59 Character ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y DEC 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 HEX 60 61 62 63 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70 71 72 73 74 75 76 77 78 79 7A Character ` a b c d e f g h i j k l m n o p q r s t u v w x y z

59 60 61 62

3B 3C 3D 3E

; < = >

90 92 94 95

5A 5C 5E 5F

Z \ ^ _

123 124 125 126

7B 7C 7D 7E

{ | } ~

Character Removal
The table below displays all acceptable characters that must be removed by the Payment Server before submitting information to the Web Service operations. See each input parameter for each Web Service operation in order to know which input parameters will have these characters removed. This character removal ensures that the Payment Servers internal XML parsers can properly read the information of the Web Service operation. Characters in the table are displayed in Courier New font. Many XML Parsers will encode these characters for you. In this case, the characters will not be converted back to their proper values by the Payment Server; they will be taken literally. Also, if you pass the encoded character through an input parameter that removes the characters listed in the table below, then certain characters may be removed (see examples below). However, if you are not using a parser, or if the parser does not handle this encoding, then the characters in the table listed below may still be removed, depending on the input parameter for the Web Service operation you are using.

Table 2. XML Character Removal

Character < > & ' " XML Parser Encoding &lt; &gt; &amp; &apos; &quot;

Example
The following example shows how characters would be removed if the data was passed through the NameOnCard parameter of the ProcessCreditCard operation. Valid: John James Invalid: Invalid: John & James becomes John James John &amp; James becomes John amp; James