Magic Portal Specification

Last Updated 05/11/2015

Introduction

The Magic eCollections Portal provides our clients with the capability to process both eCheck (ACH) and Credit Card transactions utilizing any store-front technology (e.g. eCommerce Web-Site, POS software, IVR, Kiosk Software) capable of interacting with .Net Web-Services.

Web Reference URLs:

https://secure.collectorsolutions.com/CSI_eCollections_Portal/ProcessingGateway.asmx https://secure.collectorsolutions.com/CSI_eCollections_Portal/ProcessingGateway.asmx?WSDL

Java Developers:

Use this WSDL below when consuming the web service

https://secure.collectorsolutions.com/CSI_eCollections_Portal/ProcessingGateway.wsdl

For those developers who are not using .NET and/or who are not familiar with the XML object required for standard method calls, many methods may be accessed via a 'NonNet' wrapper method. For example, you may make a call to the calculate fee method via the calculateFee method or the calculateFee_nonNET method.

When the call is made to the nonNet wrapper, the xml should be submitted as a string rather than an XML object. Furthermore, the response will be an xml string rather than an XML object (in compliance with the below specification).

NOTE: All node names ARE case sensitive.

Sample integration code:

For the following code to be functional, you must first create a 'Web Reference' using the above URL. In the example below, the 'Web Reference' was named wsCSI_eCollections_Portal.

'Here is some VB.Net sample code used after importing and/or consuming the WSDL in your preferred way. We used Visual Studio's Web Reference Wizard to add the web service.
Dim ws As new wsCSI_eCollections_Portal.ProcessingGateway 'The web service
Dim objXMLDocument_ProcessPayment As New MSXML2.DOMDocument40 'The XML obj to load your xml string
Dim objXMLDocument_ProcessPayment_XMLConvert As New System.xml.XmlDocument 'The XML obj to convert your XML doc to a XML object
Dim objXMLDocument_ProcessPayment_Response As New MSXML2.DOMDocument40 'The XML obj to hold the XML obj response
Dim xmlProcessPayment As String 'Concatenated String holding the submitted info
Dim strProcessPayment_PRC As String 'String holding the prc in the XML response
Dim strProcessPayment_ResponseCode As String 'String holding the response code in the XML response
xmlProcessPayment = "XML String created via desired technique"
objXMLDocument_ProcessPayment.loadXML(xmlProcessPayment) 'Load up an XML Doc
objXMLDocument_ProcessPayment_XMLconvert.LoadXml(objXMLDocument_ProcessPayment.xml) 'Convert to XML obj
objXMLDocument_ProcessPayment_Response.loadXML(ws.processTransaction(objXMLDocument_ProcessPayment_XMLconvert.OuterXml))'This is creating an XML object out of the XML submitted
strProcessPayment_PRC = Trim(objXMLDocument_ProcessPayment_Response.documentElement.selectSingleNode("PRC").text) 'Get text out of the PRC node
strProcessPayment_ResponseCode = Trim(objXMLDocument_ProcessPayment_Response.documentElement.selectSingleNode("RESPONSECODE").text)'Get text out of the RESPONSECODE node
//Here is some C#.Net sample code used after importing and/or consuming the WSDL in your preferred way. We used Visual Studio's Web Reference Wizard to add the web service.'
wsCSI_eCollections_Portal.ProcessingGateway ws = new wsCSI_eCollections_Portal.ProcessingGateway(); //The web service
MSXML2.DOMDocument40 objXMLDocument_ProcessPayment = new MSXML2.DOMDocument40(); //The XML obj to load your xml string
System.Xml.XmlDocument objXMLDocument_ProcessPayment_XMLConvert = new System.Xml.XmlDocument(); //The XML obj to convert your XML doc to a XML object
MSXML2.DOMDocument40 objXMLDocument_ProcessPayment_Response = new MSXML2.DOMDocument40(); //The XML obj to hold the XML obj response
string xmlProcessPayment = null; //Concatenated String holding the submitted info
string strProcessPayment_PRC = null; //String holding the prc in the XML response
string strProcessPayment_ResponseCode = null; //String holding the response code in the XML response
xmlProcessPayment = "XML String created via desired technique";
objXMLDocument_ProcessPayment.loadXML(xmlProcessPayment); //Load up an XML Doc
objXMLDocument_ProcessPayment_XMLConvert.LoadXml(objXMLDocument_ProcessPayment.xml); //Convert to XML obj
objXMLDocument_ProcessPayment_Response.loadXML(ws.processTransaction(objXMLDocument_ProcessPayment_XMLConvert.OuterXml)); //This is creating an XML object out of the XML submitted
strProcessPayment_PRC = Strings.Trim(objXMLDocument_ProcessPayment_Response.documentElement.selectSingleNode("PRC").text); //Get text out of the PRC node
strProcessPayment_ResponseCode = Strings.Trim(objXMLDocument_ProcessPayment_Response.documentElement.selectSingleNode("RESPONSECODE").text) //Get text out of the RESPONSECODE node
							
//Here is some Java sample code used after importing and/or consuming the WSDL in some form or fashion. We used NetBeans Web Service Import Wizard to add the web service.
public static void main(String[] args) throws SAXException, ParserConfigurationException, IOException {
	String strSendXML = "[The XML String to send]"; //The string to hold the xml which will be sent
	String strResponseXML = new String(); //The string to hold the response from the server
	String strResponseText = new String(); //The string to hold the responsecode node text
	String strFeeAmountText = new String(); //The string to hold the feeamount node text
	Document xmlConvert; //The xml object to parse the string into

	strResponseXML = calculatefeeNonNET(strSendXML); //Pass the xml string to the calculateFeeNonNET() method
	xmlConvert = stringToXml(strResponseXML); //Pass the response to our stringToXml() helper method
	//Parse the document. Techniques vary. We do it this way for clarity.
	Node responseTextNode = xmlConvert.getElementsByTagName("RESPONSECODE").item(0); //Get the separate nodes, such as the RESPONSECODE
	Node feeAmountTextNode = xmlConvert.getElementsByTagName("FEEAMOUNT").item(0); //Declare and assign values
	strResponseText = responseTextNode.getTextContent(); //Get text content of the RESPONSECODE node
	strFeeAmountText = feeAmountTextNode.getTextContent(); //Get text content of the FEEAMOUNT node
}
//Code generated by netbeans (Right-click in document, choose "Insert Code", then choose "Call Web Service Operation", then choose the appropriate method under Processing Gateway
private static String calculatefeeNonNET(String strXMLFee) {
	https.secure_collectorsolutions_com.csi_ecollections_portal.processinggateway.ProcessingGateway service = new https.secure_collectorsolutions_com.csi_ecollections_portal.processinggateway.ProcessingGateway();
	https.secure_collectorsolutions_com.csi_ecollections_portal.processinggateway.ProcessingGatewaySoap port = service.getProcessingGatewaySoap();
	return port.calculatefeeNonNET(strXMLFee);
}
//Helper function to convert string to xml doc
private static Document stringToXml(String strConvert) throws SAXException, ParserConfigurationException, IOException {
		DocumentBuilderFactory dbfac = DocumentBuilderFactory.newInstance();
		DocumentBuilder docBuilder = dbfac.newDocumentBuilder();
		Reader reader = new CharArrayReader(strConvert.toCharArray());
		Document returnDoc = docBuilder.parse(new InputSource(reader));
		return returnDoc;
}
//Here is some PHP sample code used after importing and/or consuming the WSDL in some form or fashion. No framework or IDE was used to import the web service.
//We tested this using a XAMPP server with PHP 5.4.3
//We're using the default SoapClient() available in php. Uncomment extension=php_openssl.dll and extension=php_soap.dll in your php.ini for this to work.
$soap_client = new SoapClient('https://secure.collectorsolutions.com/CSI_eCollections_Portal/ProcessingGateway.asmx?WSDL'); //Load up the web service WSDL
$strXmlStringRequest = '[XML string to send to the server]'; //XML string to send to server
$strXmlStringResponse = $soap_client->calculatefee_NonNET(array('strXML' => $strXmlStringRequest)); //Response from the server.
//The string is in the calculatefee_nonNETResult property of the class created. We have it printing the string into the new SimpleXMLElement constructor to make our xml doc.
$xml = new SimpleXMLElement(print_r($strXmlStringResponse->calculatefee_nonNETResult, 1)); //PHP was casting this into a stdObj.
//SimpleXMLElement can access xml child nodes like object properties
$responseCode = $xml->RESPONSECODE; //Get the RESPONSECODE node text
$fee = $xml->FEEAMOUNT;//Get the FEEAMONT node text
							
Copy to Clipboard

What Now?

Soon we will be adding code samples from different languages to help get you up to speed.

For now, check out the Reference section for more detailed info on all of our methods.

Calculate Fee

Methods

calculateFee
calculateFee_nonNET
calculateFee_nonNet_XMLObjectResponse

For those clients passing the processing fees to their customers, the fee to be charged for a transaction MUST be plainly and clearly revealed to a customer BEFORE they are allowed to submit the item for processing.

XML Submission

The child node 'LINEITEM' may be repeated 1 to n times in order to support multiple payments in one transaction.

<FEE>
	<CLIENTKEY></CLIENTKEY>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<CARDTYPE></CARDTYPE>
	<COLLECTIONMODE></COLLECTIONMODE>
	<AMOUNT></AMOUNT>
	<LINEITEM>
	<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
	<ITEMAMOUNT></ITEMAMOUNT>
	</LINEITEM>
</FEE>

*This field is only required for a Fee request of PAYMENTMETHOD '0'

Items in red are optional (with exception to the above defined rules)

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by Magic
PAYMENTMETHOD0, 1 0 for Credit Card
1 for Check
CARDTYPE3, 4, 5, 6 3 for AMEX
4 for VISA
5 for MasterCard
6 for Discovery
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)
AMOUNTCurrency <= 999,999.99
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the Magic portal and the client's MIS and/or CIS systems
ITEMAMOUNTCurrency <= 999,999.99

XML Response

<FEE>
	<FEEAMOUNT></FEEAMOUNT>
	<RESPONSECODE></RESPONSECODE>
</FEE>

The FEEAMOUNT node will be a currency value <= 999,999.99. If an error occurred, this value will be set to -1.00.

Process Transaction

Methods

processTransaction
processTransaction_nonNET
processTransaction_nonNet_XMLObjectResponse

XML Submission - Credit Cards

The child node 'LINEITEM' may be repeated 1 to n times in order to support multiple payments in one transaction.

Un-encrypted

<TRANSACTION>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<AUTHFORCE></AUTHFORCE>
	<COLLECTIONMODE></COLLECTIONMODE>
	<PRC></PRC>*
	<AMOUNT></AMOUNT>
	<FEEAMOUNT></FEEAMOUNT>
	<ALLOWDUPLICATE></ALLOWDUPLICATE>
	<NAME></NAME>
	<ADDRESS></ADDRESS>**
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>**
	<COUNTY></COUNTY>
	<STATE></STATE>**
	<ZIP></ZIP>**
	<COUNTRY></COUNTRY>**
	<EMAIL></EMAIL>
	<PHONE></PHONE>
	<SHIPPINGNAME></SHIPPINGNAME>***
	<SHIPPINGADDRESS></SHIPPINGADDRESS>***
	<SHIPPINGADDRESSTWO></SHIPPINGADDRESSTWO>
	<SHIPPINGCITY></SHIPPINGCITY>***
	<SHIPPINGSTATE></SHIPPINGSTATE>***
	<SHIPPINGZIP></SHIPPINGZIP>***
	<SHIPPINGCOUNTRY></SHIPPINGCOUNTRY>***
	<SHIPPINGEMAIL></SHIPPINGEMAIL>
	<SHIPPINGPHONE></SHIPPINGPHONE>***
	<CVV2></CVV2>*****
	<CCNUMBER></CCNUMBER>
	<EXPDATE></EXPDATE>
	<NOTES></NOTES>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>****
	<CSIPAYERID></CSIPAYERID>
	<CSIUSERID></CSIUSERID>
	<LINEITEM>
		<PAYMENTID></PAYMENTID>
		<PAYMENTID_SECONDARY></PAYMENTID_SECONDARY>
		<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
		<ITEMAMOUNT></ITEMAMOUNT>
		<MISC_ONE></MISC_ONE>
		<MISC_TWO></MISC_TWO>
		<MISC_THREE></MISC_THREE>
		<MISC_FOUR></MISC_FOUR>
		<MISC_FIVE></MISC_FIVE>
		<MISC_SIX></MISC_SIX>
		<MISC_SEVEN></MISC_SEVEN>
		<MISC_EIGHT></MISC_EIGHT>
		<MISC_NINE></MISC_NINE>
		<MISC_TEN></MISC_TEN>
		<MISC_ELEVEN></MISC_ELEVEN>
		<MISC_TWELVE></MISC_TWELVE>
		<MISC_THIRTEEN></MISC_THIRTEEN>
		<MISC_FOURTEEN></MISC_FOURTEEN>
		<MISC_FIFTEEN></MISC_FIFTEEN>
	</LINEITEM>
</TRANSACTION>
				

Encrypted

<TRANSACTION>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<AUTHFORCE></AUTHFORCE>
	<COLLECTIONMODE></COLLECTIONMODE>
	<PRC></PRC>*
	<AMOUNT></AMOUNT>
	<FEEAMOUNT></FEEAMOUNT>
	<ALLOWDUPLICATE></ALLOWDUPLICATE>
	<NAME></NAME>
	<ADDRESS></ADDRESS>**
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>**
	<COUNTY></COUNTY>
	<STATE></STATE>**
	<ZIP></ZIP>**
	<COUNTRY></COUNTRY>**
	<EMAIL></EMAIL>
	<PHONE></PHONE>
	<SHIPPINGNAME></SHIPPINGNAME>***
	<SHIPPINGADDRESS></SHIPPINGADDRESS>***
	<SHIPPINGADDRESSTWO></SHIPPINGADDRESSTWO>
	<SHIPPINGCITY></SHIPPINGCITY>***
	<SHIPPINGSTATE></SHIPPINGSTATE>***
	<SHIPPINGZIP></SHIPPINGZIP>***
	<SHIPPINGCOUNTRY></SHIPPINGCOUNTRY>***
	<SHIPPINGEMAIL></SHIPPINGEMAIL>
	<SHIPPINGPHONE></SHIPPINGPHONE>***
	<CCNUMBERMASKED></CCNUMBERMASKED>
	<EXPDATE></EXPDATE>
	<TRACK2></TRACK2>
	<DUKPT></DUKPT>
	<MPSTATUS></MPSTATUS>
	<MPDATA></MPDATA>
	<NOTES></NOTES>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>****
	<CSIPAYERID></CSIPAYERID>
	<CSIUSERID></CSIUSERID>
	<LINEITEM>
		<PAYMENTID></PAYMENTID>
		<PAYMENTID_SECONDARY></PAYMENTID_SECONDARY>
		<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
		<ITEMAMOUNT></ITEMAMOUNT>
		<MISC_ONE></MISC_ONE>
		<MISC_TWO></MISC_TWO>
		<MISC_THREE></MISC_THREE>
		<MISC_FOUR></MISC_FOUR>
		<MISC_FIVE></MISC_FIVE>
		<MISC_SIX></MISC_SIX>
		<MISC_SEVEN></MISC_SEVEN>
		<MISC_EIGHT></MISC_EIGHT>
		<MISC_NINE></MISC_NINE>
		<MISC_TEN></MISC_TEN>
		<MISC_ELEVEN></MISC_ELEVEN>
		<MISC_TWELVE></MISC_TWELVE>
		<MISC_THIRTEEN></MISC_THIRTEEN>
		<MISC_FOURTEEN></MISC_FOURTEEN>
		<MISC_FIFTEEN></MISC_FIFTEEN>
	</LINEITEM>
</TRANSACTION>

* This field is only required for a force transaction

** For AVS fraud protection or general Billing Information persistence these fields would be required

*** For Shipping Information persistence, these fields must be provided

**** This field is for backwards compatibility only. The value will be overwritten by the CSI value organizationUnitId_ProcessPayment from the User (CSIUSERID value) profile

***** This field is required for all collection modes excluding 3, 7, 9

Items in red are optional (with exception to the above defined rules)

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TRANSACTIONID1 to 32 character alpha-numeric string generated by client
PAYMENTMETHOD0, 1 0 for Credit Card
1 for Check
AUTHFORCE0, 1, 2 0 for authorize ONLY
1 for force ONLY
2 for authorize/force
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)
PRCNumeric string consisting of 8 digits� must be same as PRC of 'authorize' transaction
AMOUNTCurrency <= 999,999.99
FEEAMOUNTCurrency <= 999,999.99
ALLOWDUPLICATE1, 2 1 for No
2 for Yes

Will over-ride CSI settings to allow for 'one-time' duplicate exceptions to be controlled by client submission
NAMEString of length <= 100
ADDRESSString of length <= 100
ADDRESSTWOString of length <= 100
CITYString of length <= 50
COUNTYString of length <= 50
STATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
ZIPAlpha-numeric string of length <= 20
COUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
EMAILString of length <= 100
PHONENumeric string of length = 10
SHIPPINGNAMEString of length <= 100
SHIPPINGADDRESSString of length <= 100
SHIPPINGADDRESSTWOString of length <= 100
SHIPPINGCITYString of length <= 50
SHIPPINGSTATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
SHIPPINGZIPAlpha-numeric string of length <= 20
SHIPPINGCOUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
SHIPPINGEMAILString of length <= 100
SHIPPINGPHONENumeric string of length = 10
CVV2Numeric string consisting of 3 or 4 digits
CCNUMBERNumeric string consisting of 13 to 16 digits
EXPDATENumeric string in format MMYY
NOTESString of length <=255
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CSIPAYERIDNumeric (long) value (Assigned during the Payer creation through Administration Console)
CSIUSERIDNumeric (long) value (Assigned during the User creation through Administration Console)
PAYMENTIDAlpha-numeric string <=100 generated by client
PAYMENTID_SECONDARYAlpha-numeric string <=100 generated by client
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
ITEMAMOUNTCurrency <= 999,999.99

XML Submission - eChecks

The child node 'LINEITEM' may be repeated 1 to n times in order to support multiple payments in one transaction.

<TRANSACTION>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<COLLECTIONMODE></COLLECTIONMODE>
	<AMOUNT></AMOUNT>
	<FEEAMOUNT></FEEAMOUNT>
	<ALLOWDUPLICATE></ALLOWDUPLICATE>
	<NAME></NAME>
	<ADDRESS></ADDRESS>**
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>**
	<COUNTY></COUNTY>
	<STATE></STATE>**
	<ZIP></ZIP>**
	<EMAIL></EMAIL>
	<PHONE></PHONE>
	<SHIPPINGNAME></SHIPPINGNAME>***
	<SHIPPINGADDRESS></SHIPPINGADDRESS>***
	<SHIPPINGADDRESSTWO></SHIPPINGADDRESSTWO>
	<SHIPPINGCITY></SHIPPINGCITY>***
	<SHIPPINGSTATE></SHIPPINGSTATE>***
	<SHIPPINGZIP></SHIPPINGZIP>***
	<SHIPPINGCOUNTRY></SHIPPINGCOUNTRY>***
	<SHIPPINGEMAIL></SHIPPINGEMAIL>
	<SHIPPINGPHONE></SHIPPINGPHONE>***
	<BANKNAME></BANKNAME>
	<ACCOUNTTYPE></ACCOUNTTYPE>
	<CHECKTYPE></CHECKTYPE>
	<CHECKNUMBER></CHECKNUMBER>****
	<ROUTINGNUMBER></ROUTINGNUMBER>
	<ACCOUNTNUMBER></ACCOUNTNUMBER>
	<CHECKIMAGENAME></CHECKIMAGENAME>****
	<IAT></IAT>
	<EFFECTIVEDATE></EFFECTIVEDATE>
	<NOTES></NOTES>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>***
	<CSIPAYERID></CSIPAYERID>
	<CSIUSERID></CSIUSERID>
	<LINEITEM>
		<PAYMENTID></PAYMENTID>
		<PAYMENTID_SECONDARY></PAYMENTID_SECONDARY>
		<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
		<ITEMAMOUNT></ITEMAMOUNT>
		<MISC_ONE></MISC_ONE>
		<MISC_TWO></MISC_TWO>
		<MISC_THREE></MISC_THREE>
		<MISC_FOUR></MISC_FOUR>
		<MISC_FIVE></MISC_FIVE>
		<MISC_SIX></MISC_SIX>
		<MISC_SEVEN></MISC_SEVEN>
		<MISC_EIGHT></MISC_EIGHT>
		<MISC_NINE></MISC_NINE>
		<MISC_TEN></MISC_TEN>
		<MISC_ELEVEN></MISC_ELEVEN>
		<MISC_TWELVE></MISC_TWELVE>
		<MISC_THIRTEEN></MISC_THIRTEEN>
		<MISC_FOURTEEN></MISC_FOURTEEN>
		<MISC_FIFTEEN></MISC_FIFTEEN>
	</LINEITEM>
</TRANSACTION>

* This field is only required for a force transaction

** For AVS fraud protection or general Billing Information persistence these fields would be required

*** For Shipping Information persistence, these fields must be provided

**** This field is for backwards compatibility only. The value will be overwritten by the CSI value organizationUnitId_ProcessPayment from the User (CSIUSERID value) profile

***** This field is required for all collection modes excluding 3, 7, 9

Items in red are optional (with exception to the above defined rules)

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TRANSACTIONID1 to 32 character alpha-numeric string generated by client
PAYMENTMETHOD0, 1 0 for Credit Card
1 for Check
AUTHFORCE0, 1, 2 0 for authorize ONLY
1 for force ONLY
2 for authorize/force
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)
PRCNumeric string consisting of 8 digits� must be same as PRC of 'authorize' transaction
AMOUNTCurrency <= 999,999.99
FEEAMOUNTCurrency <= 999,999.99
ALLOWDUPLICATE1, 2 1 for No
2 for Yes

Will over-ride CSI settings to allow for 'one-time' duplicate exceptions to be controlled by client submission
NAMEString of length <= 100
ADDRESSString of length <= 100
ADDRESSTWOString of length <= 100
CITYString of length <= 50
COUNTYString of length <= 50
STATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
ZIPAlpha-numeric string of length <= 20
COUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
EMAILString of length <= 100
PHONENumeric string of length = 10
SHIPPINGNAMEString of length <= 100
SHIPPINGADDRESSString of length <= 100
SHIPPINGADDRESSTWOString of length <= 100
SHIPPINGCITYString of length <= 50
SHIPPINGSTATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
SHIPPINGZIPAlpha-numeric string of length <= 20
SHIPPINGCOUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
SHIPPINGEMAILString of length <= 100
SHIPPINGPHONENumeric string of length = 10
BANKNAMEString of length <= 100
ACCOUNTTYPE1, 2 1 for Checking
2 for Savings
CHECKTYPE1, 2 1 for Business
2 for Personal
CHECKNUMBERNumeric string : last 15 digits of check number
ROUTINGNUMBERNumeric string of length 9
ACCOUNTNUMBERNumeric string of length <=17
CHECKIMAGENAMEString of length <= 100
IAT1, 2 1 for United States (Domestic)
2 for International
EFFECTIVEDATEDate value formatted 'mm/dd/yyyy'
NOTESString of length <=255
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CSIPAYERIDNumeric (long) value (Assigned during the Payer creation through Administration Console)
CSIUSERIDNumeric (long) value (Assigned during the User creation through Administration Console)
PAYMENTIDAlpha-numeric string <=100 generated by client
PAYMENTID_SECONDARYAlpha-numeric string <=100 generated by client
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
ITEMAMOUNTCurrency <= 999,999.99

XML Response

<TRANSACTION>
	<TRANSACTIONID></TRANSACTIONID>
	<PRC></PRC>
	<RESPONSECODE></RESPONSECODE>
</TRANSACTION>

The TRANSACTIONID value will be the same as the value passed to the CSI method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TRANSACTIONID value will be empty.

The PRC value will be a numeric string consisting of 8 digits that is unique to CollectorSolutions. In the event that a submitted transaction fails prior to achieving a persistent state (e.g. during initial validation, etc), this value will be a sequence of zeros '00000000'.

Virtual Terminal Transaction

Methods

VT_Transaction_POST
VT_Transaction_GET
VT_Transaction_GET_NonNET
VT_Transaction_POST_NonNET

VT transaction data will overload localized CSI User Security settings. Thus, the CSIUSERID value will work with COLLECTIONMODE value and/or the PAYMENTID value passed in regardless of how the User is defined in the CSI system.

User security should be managed by the calling System.

XML Submission - VT_TRANSACTION_POST

<VT_TRANSACTION>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
	<COLLECTIONMODE></COLLECTIONMODE>
	<AMOUNT></AMOUNT>
	<NAME> </NAME>
	<ADDRESS></ADDRESS>
	<ADDRESSTWO></ADDRESSTWO>
	<CITY> </CITY>
	<COUNTY></COUNTY>
	<STATE> </STATE>
	<COUNTRY></COUNTRY>
	<ZIP></ZIP>
	<EMAIL></EMAIL>
	<PHONE></PHONE>
	<NOTES> </NOTES>
	<CSIUSERID></CSIUSERID>
	<LINEITEM>
		<PAYMENTID></PAYMENTID>
		<PAYMENTID_SECONDARY></PAYMENTID_SECONDARY>
		<ITEMAMOUNT></ITEMAMOUNT>
		<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
		<MISC_ONE></MISC_ONE>
		<MISC_TWO></MISC_TWO>
		<MISC_THREE></MISC_THREE>
		<MISC_FOUR></MISC_FOUR>
		<MISC_FIVE></MISC_FIVE>
		<MISC_SIX></MISC_SIX>
		<MISC_SEVEN></MISC_SEVEN>
		<MISC_EIGHT></MISC_EIGHT>
		<MISC_NINE></MISC_NINE>
		<MISC_TEN></MISC_TEN>
		<MISC_ELEVEN></MISC_ELEVEN>
		<MISC_TWELVE></MISC_TWELVE>
		<MISC_THIRTEEN></MISC_THIRTEEN>
		<MISC_FOURTEEN></MISC_FOURTEEN>
		<MISC_FIFTEEN></MISC_FIFTEEN>
	</LINEITEM>
	<URLSILENTPOST> </URLSILENTPOST>
	<URLRETURNPOST> </URLRETURNPOST>
	<ALLOWEDPAYMENTMETHOD></ALLOWEDPAYMENTMETHOD>
</VT_TRANSACTION>

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TRANSACTIONID1 to 32 character alpha-numeric string generated by client
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)
AMOUNTCurrency <= 999,999.99
NAMEString of length <= 100
ADDRESSString of length <= 100
ADDRESSTWOString of length <= 100
CITYString of length <= 50
COUNTYString of length <= 50
STATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
ZIPAlpha-numeric string of length <= 20
COUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
EMAILString of length <= 100
PHONENumeric string of length = 10
NOTESString of length <=255
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CSIPAYERIDNumeric (long) value (Assigned during the Payer creation through Administration Console)
CSIUSERIDNumeric (long) value (Assigned during the User creation through Administration Console)
PAYMENTIDAlpha-numeric string <=100 generated by client
PAYMENTID_SECONDARYAlpha-numeric string <=100 generated by client
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
ITEMAMOUNTCurrency <= 999,999.99
MISC_[NUMBER]String of length <= 100
ALLOWEDPAYMENTMETHOD0, 1, 2, 3 0 Block(eCheck and Credit Card)
1 Accept(eChecks Only)
2 Accept(Credit Cards Only)
3 Accept(eCheck and Credit Card)

XML Response - VT_TRANSACTION_POST

<VT_TRANSACTION>
	<TRANSACTIONID></TRANSACTIONID>
	<RESPONSECODE></RESPONSECODE>
</VT_TRANSACTION>

The TRANSACTIONID value will be the same as the value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TRANSACTIONID value will be empty.

Virtual Terminal Redirect

https://secure.collectorsolutions.com/csi_ecollections_portal_ui/interchange.aspx?ciid=[value]&ste=5&transid=[value]

If a URLSILENTPOST value and/or a URLRETURNPOST value were provided in the VT Transaction Post XML submission, the name-value pairs returned to those URLs will be as follows:

URL?transid=[trans id value]&status=[status value]

The 'transid' value will be the same value as the TRANSACTIONID value provided in the VT Transaction Post XML submission.

Following are the possible 'status' values:

  • -1General Error
  • 0Cancelled Transaction
  • 1Declined Transaction
  • 2Approved Transaction

XML Submission - VT_TRANSACTION_GET

<VT_TRANSACTION>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
</VT_TRANSACTION>
NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TRANSACTIONID1 to 32 character alpha-numeric string generated by client

XML Response - VT_TRANSACTION_GET

<VT_TRANSACTION>
	<TRANSACTIONID></TRANSACTIONID>
	<COUNT></COUNT>
	<RESPONSECODE> </RESPONSECODE>
	<APPROVALSTATUS></APPROVALSTATUS>
	<PRC></PRC>
	<EFFECTIVEDATE></EFFECTIVEDATE>
	<DATENOW></DATENOW>
	<TIMENOW></TIMENOW>
	<NAME> </NAME>
	<ADDRESS> </ADDRESS>
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>
	<COUNTY></COUNTY>
	<STATE></STATE>
	<ZIP></ZIP>
	<COUNTRY> </COUNTRY>
	<PHONE></PHONE>
	<EMAIL></EMAIL>
	<NOTES> </NOTES>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<CREDITCARDNUMBER></CREDITCARDNUMBER>
	<BANKNAME></BANKNAME>
	<CHECKNUMBER></CHECKNUMBER>
	<ROUTINGNUMBER></ROUTINGNUMBER>
	<ACCOUNTNUMBER></ACCOUNTNUMBER>
	<CSIUSERID></CSIUSERID>
	<COLLECTIONMODE></COLLECTIONMODE>
	<AMOUNT></AMOUNT>
	<FEEAMOUNT></FEEAMOUNT>
	<TOTALREMITTED></TOTALREMITTED>
	<LINEITEM>
		<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
		<PAYMENTID></PAYMENTID>
		<PAYMENTIDSECONDARY></PAYMENTIDSECONDARY>
		<ITEMAMOUNT></ITEMAMOUNT>
		<MISC_ONE></MISC_ONE>
		<MISC_TWO></MISC_TWO>
		<MISC_THREE></MISC_THREE>
		<MISC_FOUR></MISC_FOUR>
		<MISC_FIVE></MISC_FIVE>
		<MISC_SIX></MISC_SIX>
		<MISC_SEVEN></MISC_SEVEN>
		<MISC_EIGHT></MISC_EIGHT>
		<MISC_NINE></MISC_NINE>
		<MISC_TEN></MISC_TEN>
		<MISC_ELEVEN></MISC_ELEVEN>
		<MISC_TWELVE></MISC_TWELVE>
		<MISC_THIRTEEN></MISC_THIRTEEN>
		<MISC_FOURTEEN></MISC_FOURTEEN>
		<MISC_FIFTEEN></MISC_FIFTEEN>
	</LINEITEM>
</VT_TRANSACTION>
NameValueNotes
TRANSACTIONID1 to 32 character alpha-numeric string generated by client
COUNT-1, 0, 1 -1 for Error
0 for No transaction by that transaction id
1 for Transaction exists
RESPONSECODEA 8 character string, either beginning and ending with a Y to indicate a positive response, or a N to indicate a negative response. A negative response will contain a specific code referring to the error associated with the transaction.
APPROVALSTATUS-1, 0, 1, 2-1 for General Error
0 for Cancelled Transaction
1 for Declined Transaction
2 for Approved Transaction
PRCString 8 characters in length
EFFECTIVEDATEString, in a date format (MM/DD/YYY) payment was effective
DATENOWString, in a date format (MM/DD/YYY) this call was made
TIMENOWString, in a time format (HH:MM) this call was made
NAMEString of length <= 100
ADDRESSString of length <= 100
ADDRESSTWOString of length <= 100
CITYString of length <= 50
COUNTYString of length <= 50
STATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
ZIPAlpha-numeric string of length <= 20
COUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
PHONENumeric string of length = 10
EMAILString of length <= 100
NOTESString of length <=255
PAYMENTMETHOD3,4,5,6,9 3 for American Express
4 for Visa
5 for MasterCard
6 for Discover
9 for eCheck
CREDITCARDNUMBERString of length = 9
BANKNAMEString of length <= 100
ROUTINGNUMBERNumeric string of length 9
CHECKNUMBERNumeric string : last 15 digits of check number
ACCOUNTNUMBERNumeric string of length <= 17
CSIUSERIDNumeric (long) value (Assigned during the User creation through Administration Console)
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)
AMOUNTCurrency <= 999,999.99
FEEAMOUNTCurrency <= 999,999.99
TOTALREMITTEDCurrency <= 999,999.99
NameString <= 255 characters
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
PAYMENTIDAlpha-numeric string <=100 generated by client
PAYMENTID_SECONDARYAlpha-numeric string <=100 generated by client
ITEMAMOUNTCurrency <= 999,999.99
MISC_[NUMBER]String of length <= 100

The TRANSACTIONID value will be the same as the value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TRANSACTIONID value will be empty.

The COUNT value will be '1'.

If the TRANSACTIONID value is NOT located in the system, you will only receive the following response:

<VT_TRANSACTION>
	<TRANSACTIONID></TRANSACTIONID>
	<COUNT></COUNT>
	<RESPONSECODE> </RESPONSECODE>
</VT_TRANSACTION>

The COUNT value will be '0'.

For error situations, you will only receive the following response:

<VT_TRANSACTION>
	<TRANSACTIONID></TRANSACTIONID>
	<COUNT></COUNT>
	<RESPONSECODE> </RESPONSECODE>
</VT_TRANSACTION>

The COUNT value will be '-1'.

Manatron Transaction

Note:

Required actions to add MVP to CSI client:

  1. Ensure VT tables exist in client profile
  2. Add MVP Product Name to CSI Customer Payment Type ID value for each payment type that will be processed. If the payment type exists in MVP, but, not in CSI then add the payment type, as well.
    For CSI clients that are currently using Thomson Reuters web portal: Prior to updating Customer Payment Type ID value in CSI (in order to support MVP) coordinate with Thomson Reuters Web developers (Derek.Miller@thomsonreuters.com) �and have them update the value they are passing so that it is the same
  3. Have client administrator Add �user id from MVP (user_code) to user profiles in CSI (customer user id)
  4. Update payment screen thread to processPayment_Manatron_VirtualTerminal.aspx

Web Page URL: https://secure.collectorsolutions.com/csi_ecollections_portal_ui/interchange.aspx

WebService URL:�https://secure.collectorsolutions.com/CSI_eCollections_Portal/ProcessingGateway.asmx

Security Token:�[ClientKey]

Service Name: ProcessingGateway

Note:

All MVP User IDs (user_codes) and MVP Product Names must be Alpha-Numeric only. Available characters are:

"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz "

Additionally, all MVP User IDs (user_codes) and MVP Product Names must be unique. No two users can have the same MVP User ID and no two payment types can have the same MVP Product Name.

Methods

VT_Transaction_POST_Manatron
VT_Transaction_POST_Manatron_nonNET
VT_Transaction_GET_Manatron
VT_Transaction_GET_Manatron_nonNET

XML Submission - VT_Transaction_Post_Manatron

<PaymentInformation>
	<SecurityToken></SecurityToken>
	<VendorReferenceCode></VendorReferenceCode>
	<CartItems>
		<CartItem>
		<ProductName></ProductName>
		<AccountNumber1></AccountNumber1>
		<Amount></Amount>
		</CartItem>
	</CartItems>
	<UserField1></UserField1>
</PaymentInformation>

The UserField1 value is to be assigned the Customer User ID value which must have been previously assigned to a User Profile within the CSI system.

XML Response - VT_Transaction_Post_Manatron

<SaveInformationResponse>
	<StatusCode></StatusCode>
	<Token></Token>
	<Message></Message>
</SaveInformationResponse>

The StatusCode value will be '0' if the POST request was successful; it will be '9999' if it is not.

The Token value will be the same as the VendorReferenceCode value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the Token value will be empty.

The Message value corresponds to the CSI RESPONSECODE value.

Virtual Terminal Redirect

https://secure.collectorsolutions.com/csi_ecollections_portal_ui/interchange.aspx?token=[value]

XML Submission � VT_Transaction_GET_Manatron

<PaymentVerification>
	<SecurityToken></SecurityToken>
	<VendorReferenceCode></VendorReferenceCode>
</PaymentVerification>

XML Response � VT_Transaction_GET_Manatron

<PaymentVerificationResponse>
	<StatusCode></StatusCode>
	<TransactionDate></TransactionDate>
	<Transactions>
		<Transaction>
			<ItemType></ItemType>
			<ConfirmationNumber></ConfirmationNumber>
			<Amount></Amount>
			<ConvenienceFee></ConvenienceFee>
			<AuthorizationCode></AuthorizationCode>
		</Transaction>
	</Transactions>
	<PayeeName></PayeeName>
	<PaymentType></PaymentType>
	<LastFour></LastFour>
	<CCExpiration></CCExpiration>
</PaymentVerificationResponse>

The StatusCode value will be '0' if the transaction had been approved; it will be '2009 if the transaction had been Declined.

If the vendor reference code is NOT located in the system, you will only receive the following response:

<PaymentVerificationResponse>
	<StatusCode></StatusCode>
</PaymentVerificationResponse>

The StatusCode value will be '0'.

For error situations, you will only receive the following response:

<PaymentVerificationResponse>
	<StatusCode></StatusCode>
	<Message></Message>
</PaymentVerificationResponse>

The StatusCode value will be '9999'.

The Message value corresponds to the CSI RESPONSECODE value.

Tokenization

Methods

recurringTransaction_TokenCreation
processRecurringTransaction_ByToken

XML Submission � recurringTransaction_TokenCreation : eCheck

<RECURRINGTOKEN>
	<CLIENTKEY></CLIENTKEY>
	<TOKENID></TOKENID>*�������������������������������������������������������������������������������������������������������
	<PAYMENTMETHOD></PAYMENTMETHOD>����������������������������������������������������������������������
	<BANKNAME></BANKNAME>
	<ACCOUNTTYPE></ACCOUNTTYPE>
	<CHECKTYPE></CHECKTYPE>
	<IAT></IAT>��������������������������������������������������������������������������������������������������������������������������
	<ROUTINGNUMBER></ROUTINGNUMBER>
	<ACCOUNTNUMBER></ACCOUNTNUMBER>
	<NAME></NAME>
	<ADDRESS></ADDRESS>
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>
	<COUNTY></COUNTY>
	<STATE></STATE>
	<ZIP></ZIP>
	<COUNTRY></COUNTRY>
	<EMAIL></EMAIL>
	<PHONE></PHONE>
</RECURRINGTOKEN>

* Must be unique value for all historical tokenized items.

Items in red are optional (with exception to the above defined rules)

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TOKENID1 to 32 character alpha-numeric string generated by client
PAYMENTMETHOD0, 1 0 for Credit Card
1 for Check
BANKNAMEString of length <= 100
ACCOUNTTYPE1, 2 1 for Checking
2 for Savings
CHECKTYPE1, 2 1 for Business
2 for Personal
ROUTINGNUMBERNumeric string of length 9
ACCOUNTNUMBERNumeric string of length <=17
IAT1, 2 1 for United States (Domestic)
2 for International
NAMEString of length <= 100
ADDRESSString of length <= 100
ADDRESSTWOString of length <= 100
CITYString of length <= 50
COUNTYString of length <= 50
STATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
ZIPAlpha-numeric string of length <= 20
COUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
EMAILString of length <= 100
PHONENumeric string of length = 10

XML Submission � recurringTransaction_TokenCreation : Credit Card

<RECURRINGTOKEN>
	<CLIENTKEY></CLIENTKEY>
	<TOKENID></TOKENID>*�������������������������������������������������������������������������������������������������������
	<PAYMENTMETHOD></PAYMENTMETHOD>����������������������������������������������������������������������
	<CCNUMBER></CCNUMBER>
	<EXPDATE></EXPDATE>
	<NAME></NAME>
	<ADDRESS></ADDRESS>
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>
	<COUNTY></COUNTY>
	<STATE></STATE>
	<ZIP></ZIP>
	<COUNTRY></COUNTRY>
	<EMAIL></EMAIL>
	<PHONE></PHONE>
</RECURRINGTOKEN>

* Must be unique value for all historical tokenized items.

Items in red are optional (with exception to the above defined rules)

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TOKENID1 to 32 character alpha-numeric string generated by client
PAYMENTMETHOD0, 1 0 for Credit Card
1 for Check
CCNUMBER
EXPDATE
NAMEString of length <= 100
ADDRESSString of length <= 100
ADDRESSTWOString of length <= 100
CITYString of length <= 50
COUNTYString of length <= 50
STATEThis should be the full State name (as opposed to abbreviation)String of length <= 50
ZIPAlpha-numeric string of length <= 20
COUNTRYThis should be the full Country name (as opposed to abbreviation)String of length <= 50
EMAILString of length <= 100
PHONENumeric string of length = 10

XML Response � recurringTransaction_TokenCreation

<RECURRINGTOKEN>
	<TOKENID></TOKENID>
	<TOKEN></TOKEN>*��������������������������������������������������������������������������������
	<RESPONSECODE></RESPONSECODE>
</RECURRINGTOKEN>

*16 bit guid (36 characters including '-')

The TOKENID value will be the same as the value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TOKENID value will be empty.

If an error occurs, the TOKEN value will be a sequence of zeros '00000000'.

XML Submission � processRecurringTransaction_ByToken

<TRANSACTION>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<COLLECTIONMODE></COLLECTIONMODE>**
	<AMOUNT></AMOUNT>
	<FEEAMOUNT></FEEAMOUNT>
	<TOKEN></TOKEN>*
	<NOTES></NOTES>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>****
	<CSIPAYERID></CSIPAYERID>
	<CSIUSERID></CSIUSERID>
	<LINEITEM>
		<PAYMENTID></PAYMENTID>
		<PAYMENTID_SECONDARY></PAYMENTID_SECONDARY>
		<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
		<ITEMAMOUNT></ITEMAMOUNT>
	</LINEITEM>
</TRANSACTION>

* 16 bit guid (36 characters including '-')

** Value of 7 for PAP

Items in red are optional (with exception to the above defined rules)

XML Response � processRecurringTransaction_ByToken

<TRANSACTION>
	<TRANSACTIONID></TRANSACTIONID>
	<PRC></PRC>
	<RESPONSECODE></RESPONSECODE>
</TRANSACTION>

The TRANSACTIONID value will be the same as the value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TRANSACTIONID value will be empty.

The PRC value will be a numeric string consisting of 8 digits that is unique to CollectorSolutions. In the event that a submitted transaction fails prior to achieving a persistent state (e.g. during initial validation, etc), this value will be a sequence of zeros '00000000'.

Update Token

Methods

updateToken
updateTokenResponse

XML Submission - updateToken

	<CLIENTKEY></CLIENTKEY>
	<TOKENID></TOKENID>*
	<NAME></NAME>
	<NOTES></NOTES>
	<CSIUSERID></CSIUSERID>
	<URLSILENTPOST></URLSILENTPOST>
	<URLRETURNPOST></URLRETURNPOST>

* Must be unique value for all historical tokenized items.

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TOKENID1 to 32 character alpha-numeric string generated by client
NAMEString of length <= 100
NOTESString of length <= 255
CSIUSERIDNumeric (long) value (Assigned during the USer creation through Administration Console)

XML Response - updateTokenResponse

<TOKENID></TOKENID>
<RESPONSECODE></RESPONSECODE>

The TOKENID value will be the same as the value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TOKENID value will be empty.

VT Tokenization

Methods

VT_CreateToken_POST
VT_CreateToken_GET

XML Submission - VT_CreateToken_POST

<VT_TOKEN>
	<CLIENTKEY></CLIENTKEY>
	<TOKENID></TOKENID>*
	<NAME></NAME>
	<NOTES></NOTES>
	<CSIUSERID></CSIUSERID>
	<URLSILENTPOST></URLSILENTPOST>
	<URLRETURNPOST></URLRETURNPOST>
</VT_TOKEN>

* Must be unique value for all historical tokenized items.

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TOKENID1 to 32 character alpha-numeric string generated by client
NAMEString of length <= 100
NOTESString of length <= 255
CSIUSERIDNumeric (long) value (Assigned during the USer creation through Administration Console)

XML Response - VT_CreateToken_POST

<VT_TOKEN>
	<TOKENID></TOKENID>
	<RESPONSECODE></RESPONSECODE>
</VT_TOKEN>

The TOKENID value will be the same as the value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TOKENID value will be empty.

Virtual Terminal Redirect

https://secure.collectorsolutions.com/csi_ecollections_portal_ui/interchange.aspx?ciid=[value]&ste=5&fctn=2&tokenid=[value]

If a URLSILENTPOST value and/or a URLRETURNPOST value were provided in the VT Create Token Post XML submission, the name-value pairs returned to those URLs will be as follows:

URL?tokenid=[token id value]&status=[status value]

The 'tokenid' value will be the same value as the TOKENID value provided in the VT Create Token Post XML submission.

Following are the possible 'status' values:

  • -1General Error
  • 0Cancelled Request
  • 1Declined Request
  • 2Approved Request

XML Submission - VT_CreateToken_GET

<VT_TOKEN>
	<CLIENTKEY></CLIENTKEY>
	<TOKENID></TOKENID>
</VT_TOKEN>
NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TOKENIDAlpha-numeric string <= 100

XML Response - VT_CreateToken_GET

Checks:

<VT_TOKEN>
	<TOKENID></TOKENID>
	<TOKEN></TOKEN>**
	<RESPONSECODE></RESPONSECODE>
	<NAME></NAME>
	<ADDRESS></ADDRESS>
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>
	<COUNTY></COUNTY>
	<STATE></STATE>
	<ZIP></ZIP>
	<COUNTRY></COUNTRY>
	<PHONE></PHONE>
	<EMAIL></EMAIL>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<BANKNAME></BANKNAME>
	<ROUTINGNUMBER></ROUTINGNUMBER>
	<ACCOUNTNUMBER></ACCOUNTNUMBER>*
</VT_TOKEN>

Credit Cards:

<VT_TOKEN>
	<TOKENID></TOKENID>
	<TOKEN></TOKEN>**
	<RESPONSECODE></RESPONSECODE>
	<NAME></NAME>
	<ADDRESS></ADDRESS>
	<ADDRESSTWO></ADDRESSTWO>
	<CITY></CITY>
	<COUNTY></COUNTY>
	<STATE></STATE>
	<ZIP></ZIP>
	<COUNTRY></COUNTRY>
	<PHONE></PHONE>
	<EMAIL></EMAIL>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<CREDITCARDNUMBER></CREDITCARDNUMBER>*
	<EXPDATE></EXPDATE>*
</VT_TOKEN>

* Only the last 4 digits of the value provided are returned

** 16 bit guid (36 characters including '-')

The TOKENID value will be the same as the value passed to the method by the client. In the event that the XML submission could not be parsed (causing the error condition) the TOKENID value will be empty.

If an error occurs, the TOKEN value will be a sequence of zeros '00000000'.

The COUNT value will be '1'.

If the TOKENID value is NOT located in the system, you will only receive the following response:

<VT_TOKEN>
	<TOKENID></TOKENID>
	<TOKEN></TOKEN>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
</VT_TOKEN>

The TOKEN value will be a sequence of zeros '00000000'.

The COUNT value will be '0'.

For error situations, you will only receive the following response:

<VT_TOKEN>
	<TOKENID></TOKENID>
	<TOKEN></TOKEN>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
</VT_TOKEN>

The TOKEN value will be a sequence of zeros '00000000'.

The COUNT value will be '-1'.

Void/Credit Processing

Methods

processCredit
processCredit_nonNET

XML Submission

<CREDIT>
	<CLIENTKEY></CLIENTKEY>
	<PRC></PRC>
	<AMOUNT></AMOUNT>
	<INTERNALCREDIT></INTERNALCREDIT>
	<CHARGEBACK></CHARGEBACK>
	<NOTES></NOTES>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>*
	<CSIUSERID></CSIUSERID>
</CREDIT>

* This field is for backwards compatibility only. The value will be overwritten by the CSI value organization unit id � process payment' from the User (CSIUSERID value) profile.

Items in red are optional (with exception to the above defined rules)

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
PRCNumeric string consisting of 8 digits� must be same as PRC of 'original' transaction
AMOUNTCurrency <= the original transaction amount. Note, this value should not reflect any fees charged for the original transaction. The percentage of fees refunded (if applicable) will be automatically calculated by multiplying the original fee amount (if applicable) by the ratio of the credited amount/original amount. For transactions representing multiple payment items, this value must be the same as the original transaction.
INTERNALCREDIT0, 10 for complete (resolves back to originated account), 1 for internal purposes only (updates reports for reconciliation) (for CSI use only)
CHARGEBACK0, 10 for No, 1 for Yes (for CSI use only)
NOTESString of length <= 255
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CSIUSERIDNumeric (long) value (Assigned during the User creation through Administration Console)

XML Response

<CREDIT>
	<PRC></PRC>
	<AMOUNTCREDITED></AMOUNTCREDITED>
	<FEEAMOUNTCREDITED></FEEAMOUNTCREDITED>
	<TOTALAMOUNTCREDITED></TOTALAMOUNTCREDITED>
	<RESPONSECODE></RESPONSECODE>*
</CREDIT>

The PRC node will be the same value as the original transaction.

If an error occurred, all 'amount' values will be set to the value -1.00.

Export Detailed Transactions

Methods

export_DetailedTransactions
export_DetailedTransactions_nonNET
export_DetailedTransactions_Update
export_DetailedTransactions_Update_nonNET

The export_DetailedTransactions and export_DetailedTransactions_nonNET methods will return all transactions that occurred during the specified date range.

The export_DetailedTransactions_Update and export_DetailedTransactions_Update_nonNET methods are nuanced in that only those transactions that have not been included in previous export requests will be returned.

XML Submission � export_DetailTransactions

<EXPORT>
	<CLIENTKEY></CLIENTKEY>
	<STARTDATE></STARTDATE>
	<ENDDATE></ENDDATE>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
	<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
	<COLLECTIONMODE></COLLECTIONMODE>
</EXPORT>

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
STARTDATEDate value formatted 'mm/dd/yyyy'
ENDDATEDate value formatted 'mm/dd/yyyy'
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)

XML Submission � export_DetailTransactions_Update

<EXPORT>
	<CLIENTKEY></CLIENTKEY>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
	<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
	<COLLECTIONMODE></COLLECTIONMODE>
</EXPORT>

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)

XML Response

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
	<TRANSACTION>
		<EFFECTIVEDATE></EFFECTIVEDATE>
		<NAME></NAME>
		<PRC></PRC>
		<PAYMENTMETHOD></PAYMENTMETHOD>
		<BANKNAME></BANKNAME>
		<CHECKNUMBER></CHECKNUMBER>
		<ROUTINGNUMBER></ROUTINGNUMBER>
		<ACCOUNTNUMBER></ACCOUNTNUMBER>
		<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
		<COLLECTIONMODE></COLLECTIONMODE>
		<AMOUNT></AMOUNT>
		<LINEITEM>
			<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
			<PAYMENTID></PAYMENTID>
			<PAYMENTIDSECONDARY></PAYMENTIDSECONDARY>
			<ITEMAMOUNT></ITEMAMOUNT>
		</LINEITEM>
	</TRANSACTION>
</EXPORT>

The PAYMENTMETHOD value is expanded from that of the Transaction submission. This node may take on the following values:

  • 3American Express
  • 9Check
  • 6Discover
  • 5MasterCard
  • 4VISA

The items in red will only be present for a PAYMENTMETHOD value of 9.

The COUNT node will be a long value representing the number of transactions identified for the provided filter(s). If an error occurred, this value will be set to -1.

For error situations, you will only receive the following response:

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
</EXPORT>

The COUNT value will be '-1'.

Export Check Credits

Methods

export_CheckCredits

XML Submission

<EXPORT>
	<CLIENTKEY></CLIENTKEY>
	<STARTDATE></STARTDATE>
	<ENDDATE></ENDDATE>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
	<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
	<COLLECTIONMODE></COLLECTIONMODE>
</EXPORT>

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
STARTDATEDate value formatted 'mm/dd/yyyy'
ENDDATEDate value formatted 'mm/dd/yyyy'
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)

XML Response

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
	<TRANSACTION>
		<EFFECTIVEDATE></EFFECTIVEDATE>
		<CREDITDATE></CREDITDATE>
		<CREDITTYPE></CREDITTYPE>
		<NAME></NAME>
		<PRC></PRC>
		<EMAIL></EMAIL>
		<NOTES></NOTES>
		<BANKNAME></BANKNAME>
		<CHECKNUMBER></CHECKNUMBER>
		<ROUTINGNUMBER></ROUTINGNUMBER>
		<ACCOUNTNUMBER></ACCOUNTNUMBER>
		<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
		<COLLECTIONMODE></COLLECTIONMODE>
		<AMOUNT></AMOUNT>
		<CREDITAMOUNT></CREDITAMOUNT>
		<LINEITEM>
			<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
			<PAYMENTID></PAYMENTID>
			<PAYMENTIDSECONDARY></PAYMENTIDSECONDARY>
			<ITEMAMOUNT></ITEMAMOUNT>
		</LINEITEM>
	</TRANSACTION>
</EXPORT>

The COUNT node will be a long value representing the number of transactions identified for the provided filter(s).

For error situations, you will only receive the following response:

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
</EXPORT>

The COUNT value will be '-1'.

Export Check Returns

Methods

export_CheckReturns

XML Submission

<EXPORT>
	<CLIENTKEY></CLIENTKEY>
	<STARTDATE></STARTDATE>
	<ENDDATE></ENDDATE>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
	<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
	<COLLECTIONMODE></COLLECTIONMODE>
</EXPORT>

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)

XML Response

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
	<TRANSACTION>
		<EFFECTIVEDATE></EFFECTIVEDATE>
		<RETURNDATE></RETURNDATE>
		<RETURNCODE></RETURNCODE>
		<NAME></NAME>
		<PRC></PRC>
		<BANKNAME></BANKNAME>
		<CHECKNUMBER></CHECKNUMBER>
		<ROUTINGNUMBER></ROUTINGNUMBER>
		<ACCOUNTNUMBER></ACCOUNTNUMBER>
		<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
		<COLLECTIONMODE></COLLECTIONMODE>
		<AMOUNT></AMOUNT>
		<LINEITEM>
			<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
			<PAYMENTID></PAYMENTID>
			<PAYMENTIDSECONDARY></PAYMENTIDSECONDARY>
			<ITEMAMOUNT></ITEMAMOUNT>
		</LINEITEM>
	</TRANSACTION>
</EXPORT>

The COUNT node will be a long value representing the number of transactions identified for the provided filter(s).

For error situations, you will only receive the following response:

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
</EXPORT>

The COUNT value will be '-1'.

Export Credit Card Credits

Methods

export_CreditCardCredits

XML Submission

<EXPORT>
	<CLIENTKEY></CLIENTKEY>
	<STARTDATE></STARTDATE>
	<ENDDATE></ENDDATE>
	<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
	<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
	<COLLECTIONMODE></COLLECTIONMODE>
</EXPORT>

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
STARTDATEDate value formatted 'mm/dd/yyyy'
ENDDATEDate value formatted 'mm/dd/yyyy'
CSIORGANIZATIONUNITIDNumeric (long) value (Assigned during the Organizational Unit creation through Administration Console)
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
COLLECTIONMODE1, 2, 3, 4, 5, 6, 7, 8, 9, 10 1 for Web
2 for POS (manual)
3 for POS (scanned)
4 for Tel
5 for IVR
6 for Email
7 for Pre-Authorization
8 for Web (other)
9 for Mailroom-Dropbox (manual)
10 for Mailroom-Dropbox (scanned)

XML Response

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
	<TRANSACTION>
		<EFFECTIVEDATE></EFFECTIVEDATE>
		<CREDITDATE></CREDITDATE>
		<CREDITTYPE></CREDITTYPE>
		<NAME></NAME>
		<PRC></PRC>
		<EMAIL></EMAIL>
		<NOTES></NOTES>
		<CSIORGANIZATIONUNITID></CSIORGANIZATIONUNITID>
		<COLLECTIONMODE></COLLECTIONMODE>
		<AMOUNT></AMOUNT>
		<CREDITAMOUNT></CREDITAMOUNT>
		<LINEITEM>
			<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
			<PAYMENTID></PAYMENTID>
			<PAYMENTIDSECONDARY></PAYMENTIDSECONDARY>
			<ITEMAMOUNT></ITEMAMOUNT>
		</LINEITEM>
	</TRANSACTION>
</EXPORT>

The PAYMENTMETHOD value is expanded from that of the Transaction submission. This node may take on the following values:

  • 3American Express
  • 6Discover
  • 5MasterCard
  • 4VISA

The COUNT node will be a long value representing the number of transactions identified for the provided filter(s).

For error situations, you will only receive the following response:

<EXPORT>
	<COUNT></COUNT>
	<RESPONSECODE></RESPONSECODE>
</EXPORT>

The COUNT value will be '-1'.

Export Credit Card Fee Structure

Methods

export_FeeStructure_CreditCards

XML Submission

<EXPORT>
	<CLIENTKEY></CLIENTKEY>
</EXPORT>
NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI

DataSet Response

For this method, a .Net dataset object will be returned. In the event of an error, the dataset will be empty.

Following is a sample xml schema for the returned dataset object:

<CSI_CreditCard_Structure>
     <fees>
         <creditCardFeeID>1</creditCardFeeID>
         <lowerLimit>0</lowerLimit>
         <upperLimit>33.0000</upperLimit>
         <baseFee_POP_Manual>1.0000</baseFee_POP_Manual>
         <percentFee_POP_Manual>0</percentFee_POP_Manual>
         <baseFee_POP_Electronic>1.0000</baseFee_POP_Electronic>
         <percentFee_POP_Electronic>0</percentFee_POP_Electronic>
         <baseFee_PreAuthorization>1.0000</baseFee_PreAuthorization>
         <percentFee_PreAuthorization>0</percentFee_PreAuthorization>
         <baseFee_Email>1.0000</baseFee_Email>
         <percentFee_Email>0</percentFee_Email>
         <baseFee_IVR>1.0000</baseFee_IVR>
         <percentFee_IVR>0</percentFee_IVR>
         <baseFee_Web>1.0000</baseFee_Web>
         <percentFee_Web>0</percentFee_Web>
         <baseFee_Tel>1.0000</baseFee_Tel>
         <percentFee_Tel>0</percentFee_Tel>
         <baseFee_MailDrop_Manual>1.0000</baseFee_MailDrop_Manual>
         <percentFee_MailDrop_Manual>0</percentFee_MailDrop_Manual>
     </fees>
     <fees>
         <creditCardFeeID>2</creditCardFeeID>
         <lowerLimit>33.0100</lowerLimit>
         <upperLimit>100.0000</upperLimit>
         <baseFee_POP_Manual>0</baseFee_POP_Manual>
         <percentFee_POP_Manual>0.03</percentFee_POP_Manual>
         <baseFee_POP_Electronic>0</baseFee_POP_Electronic>
         <percentFee_POP_Electronic>0.03</percentFee_POP_Electronic>
         <baseFee_PreAuthorization>0</baseFee_PreAuthorization>
         <percentFee_PreAuthorization>0.03</percentFee_PreAuthorization>
         <baseFee_Email>0</baseFee_Email>
         <percentFee_Email>0.03</percentFee_Email>
         <baseFee_IVR>0</baseFee_IVR>
         <percentFee_IVR>0.03</percentFee_IVR>
         <baseFee_Web>0</baseFee_Web>
         <percentFee_Web>0.03</percentFee_Web>
         <baseFee_Tel>0</baseFee_Tel>
         <percentFee_Tel>0.03</percentFee_Tel>
         <baseFee_MailDrop_Manual>0</baseFee_MailDrop_Manual>
         <percentFee_MailDrop_Manual>0.03</percentFee_MailDrop_Manual>
       </fees>
	   .
	   .
	   .
</CSI_CreditCard_Structure>

The number of 'fees' nodes are variable depending on the granularity and range of the pricing ranges.

Verify Transaction

Methods

verifyTransaction
verifyTransaction_nonNET

XML Submission

<VERIFY>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
</VERIFY><

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
TRANSACTIONID1 to 32 character alpha-numeric string generated by client

XML Response

<VERIFY>
	<RESPONSECODE></RESPONSECODE>
		<VERIFIED>2</VERIFIED>
	<TRANSACTIONID></TRANSACTIONID>
	<PRC></PRC>
	<DATE></DATE>
	<TIME></TIME>
	<NAME></NAME>
	<CARDTYPE></CARDTYPE>
	<CREDITCARDNUMBER></CREDITCARDNUMBER>
	<CHECKINGACCOUNTNUMBER></CHECKINGACCOUNTNUMBER>
	<AMOUNT></AMOUNT>
	<FEEAMOUNT></FEEAMOUNT>
	<TOTALREMITTED></TOTALREMITTED>
</VERIFY><

If the transaction id is NOT located in the system, you will only receive the following response:

<VERIFY>
	<RESPONSECODE></RESPONSECODE>
		<VERIFIED>1</VERIFIED>
	<TRANSACTIONID></TRANSACTIONID>
</VERIFY><

The VERIFIED value will be '1'.

For error situations, you will only receive the following response:

<VERIFY>
	<RESPONSECODE></RESPONSECODE>
		<VERIFIED>-1</VERIFIED>
	<TRANSACTIONID></TRANSACTIONID>
</VERIFY><

The VERIFIED value will be '-1'.

Verify Payment ID

Methods

verifyPaymentID
verifyPaymentID_nonNET

XML Submission

<VERIFY>
	<CLIENTKEY></CLIENTKEY>
	<CUSTOMERPAYMENTTYPEID></CUSTOMERPAYMENTTYPEID>
	<PAYMENTID></PAYMENTID>
</VERIFY><
NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
CUSTOMERPAYMENTTYPEIDAlpha-numeric string value <= 32 generated by client and used for the purpose of a join between the CSI portal and the client's MIS and/or CIS systems
PAYMENTIDAlpha-numeric string <=100 generated by client

XML Response

<VERIFY>
	<VERIFIED></VERIFIED>
	<AMOUNTDUE></AMOUNTDUE>
	<PAYMENTID></PAYMENTID>
	<CUSTOMERDESCRIPTOR_PRIMARY></CUSTOMERDESCRIPTOR_PRIMARY>
	<CUSTOMERDESCRIPTOR_SECONDARY></CUSTOMERDESCRIPTOR_SECONDARY>
</VERIFY><

The VERIFIED value will be '2'.

If the transaction id is NOT located in the system, you will only receive the following response:

<VERIFY>
	<VERIFIED></VERIFIED>
</VERIFY><

The VERIFIED value will be '1'.

For error situations, you will only receive the following response:

<VERIFY>
	<VERIFIED></VERIFIED>
	<RESPONSECODE></RESPONSECODE>
</VERIFY><

The VERIFIED value will be '-1'.

Insert Payment ID Lookup

Methods

insertPaymentIdLookup
insertPaymentIdLookup_nonNET

XML Submission

<PAYMENTIDLOOKUP>
	<CLIENTKEY></CLIENTKEY>
	<LINEITEM>
	<PAYMENTID_PRIMARY></PAYMENTID_PRIMARY>
	<PAYMENTID_SECONDARY></PAYMENTID_SECONDARY>
	<ITEMAMOUNT></ITEMAMOUNT>
	<CUSTOMERDESCRIPTOR_PRIMARY></CUSTOMERDESCRIPTOR_PRIMARY>
	<CUSTOMERDESCRIPTOR_SECONDARY></CUSTOMERDESCRIPTOR_SECONDARY>
	<PAYMENTTYPEID></PAYMENTTYPEID>
	<MISC_ONE></MISC_ONE>
	<MISC_TWO></MISC_TWO>
	<MISC_THREE></MISC_THREE>
	<MISC_FOUR></MISC_FOUR>
	<MISC_FIVE></MISC_FIVE>
	<MISC_SIX></MISC_SIX>
	<MISC_SEVEN></MISC_SEVEN>
	<MISC_EIGHT></MISC_EIGHT>
	<MISC_NINE></MISC_NINE>
	<MISC_TEN></MISC_TEN>
	<MISC_ELEVEN></MISC_ELEVEN>
	<MISC_TWELVE></MISC_TWELVE>
	<MISC_THIRTEEN></MISC_THIRTEEN>
	<MISC_FOURTEEN></MISC_FOURTEEN>
	<MISC_FIFTEEN></MISC_FIFTEEN>
	</LINEITEM>
</PAYMENTIDLOOKUP>

Items in red are optional.

The child node 'LINEITEM' may be repeated 1 to n times in order to support multiple payments in one transaction.

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
PAYMENTID_PRIMARYAlpha-numeric string <=100 generated by client usually representing the customer primary account number
PAYMENTID_SECONDARYAlpha-numeric string <=100 generated by client
AMOUNTDUECurrency <= 999,999.99
CUSTOMERDESCRIPTOR_PRIMARYAlpha-numeric string <=100 generated by client
CUSTOMERDESCRIPTOR_SECONDARYAlpha-numeric string <=100 generated by client
PAYMENTTYPEIDNumeric
MISC_ONE thru MISC_FIFTEENAlpha-numeric string <=100 generated by client

XML Response

<PAYMENTIDLOOKUP>
	<RECORDCOUNT></RECORDCOUNT>
	<RESPONSECODE>YXXXXXXY</RESPONSECODE>
</PAYMENTIDLOOKUP>

For error situations, you will only receive the following response:

<PAYMENTIDLOOKUP>
	<RECORDCOUNT>0</RECORDCOUNT>
	<RESPONSECODE>NXXXXXXN</RESPONSECODE>
</PAYMENTIDLOOKUP>

Delete Payment ID Lookup

Methods

deletePaymentIdLookup
deletePaymentIdLookup_nonNET

XML Submission

Payment information can be deleted one line at a time by supplying the PAYMENTID_PRIMARY node data, or a group of paymentTypeId's can be deleted by passing in only the PAYMENTTYPEID. All records in the table can be deleted by passing only the CLIENTKEY.

<PAYMENTIDLOOKUP>
	<CLIENTKEY></CLIENTKEY>
	<PAYMENTID_PRIMARY></PAYMENTID_PRIMARY>
	<PAYMENTTYPEID></PAYMENTTYPEID>
</PAYMENTIDLOOKUP>

Items in red are optional

NameValueNotes
CLIENTKEY32 character alpha-numeric string assigned during initial set-up by CSI
PAYMENTID_PRIMARYAlpha-numeric string <=100 generated by client usually representing the customer primary account number
PAYMENTID_SECONDARYAlpha-numeric string <=100 generated by client

XML Response

<PAYMENTIDLOOKUP>
	<RECORDCOUNT># of records deleted</RECORDCOUNT>
	<RESPONSECODE>Y123456Y</RESPONSECODE>
</PAYMENTIDLOOKUP>

For error situations, you will only receive the following response:

<PAYMENTIDLOOKUP>
	<RECORDCOUNT>0</RECORDCOUNT>
	<RESPONSECODE>NXXXXXXN</RESPONSECODE>
</PAYMENTIDLOOKUP>

Test Values

Credit Card Values

NameExpiration DateCVV2Result
41111111111111111218123YTESTEDY
543111111111111112181234N511111N : Declined Transaction Test Scenario
3411111111111111218123N919999N : General Error Test Scenario
60116011601166111218123N319999N : Invalid Data Test Scenario

Check Values

Routing NumberAccount NumberResult
0632101124111111111YTESTEDY
0632101121111111111N919999N : General Error Test Scenario
0632101129999999999N319999N : Invalid Data Test Scenario

Test Values

Credit Card Values

NameExpiration DateCVV2Result
41111111111111111218123YTESTEDY
543111111111111112181234N511111N : Declined Transaction Test Scenario
3411111111111111218123N919999N : General Error Test Scenario
60116011601166111218123N319999N : Invalid Data Test Scenario

Check Values

Routing NumberAccount NumberResult
0632101124111111111YTESTEDY
0632101121111111111N919999N : General Error Test Scenario
0632101129999999999N319999N : Invalid Data Test Scenario

Test Connectivity

Methods

test_nonNET

The test_nonNET method accepts a simple string of less than 32 characters (any extra characters will simply be truncated) as an argument and returns the same string in reverse order� the method is provided for developers to utilize in order to quickly develop a simple proof of concept demonstrating SOAP connectivity and interaction with the CSI eCollections Portal.

Invalid XML Characters

There are several characters that are not allowed in the XML context. However, for these characters, there are predefined references that can be used for their representation.

Invalid CharacterReference
<&lt;
>&gt;
&&amp;
'&apos;
"&quot;

Note: Only the characters �<� and �&� are strictly illegal in XML. Apostrophes, quotation marks and greater than signs are legal, but it is a good habit to replace them.

The CDATA tag can be used to avoid invalid character errors, as well.

Everything inside a CDATA section is ignored by the parser. Thus, if your text contains a lot of �<� or �&� characters, the XML element can be defined as a CDATA section.

A CDATA section starts with �<![CDATA[� and ends with �]]>�:

<TRANSACTION>
	<CLIENTKEY></CLIENTKEY>
	<TRANSACTIONID></TRANSACTIONID>
	<PAYMENTMETHOD></PAYMENTMETHOD>
	<AUTHFORCE></AUTHFORCE>
	<COLLECTIONMODE></COLLECTIONMODE>
	<PRC></PRC>
	<AMOUNT></AMOUNT>
	<FEEAMOUNT></FEEAMOUNT>
	<NAME><![CDATA[Ben & Jerry's]]</NAME>
	.
	.
	.
<TRANSACTION>

Note: A CDATA section cannot contain the string �]]>�.

For the CSI portal, CDATA sections are not supported. Rather, the ampersand (&) and apostrophe (&pos;) characters should be encoded (as specified in the table above).

The three other invalid characters will not be supported.

Appendix A - Methods

Method Descriptions for the CSI ProcessingGateway web-service:

https://secure.collectorsolutions.com/CSI_eCollections_Portal/ProcessingGateway.asmx

The CSI ProcessingGateway web-service provides our clients with multiple utilities that facilitate the real-time processing and management of internet based credit card and eCheck transactions. This service is intended for the use of current CSI clients ONLY. Any unauthorized use is strictly prohibited.

The following operations are supported. For a formal definition, please review the Service Description.

  • calculateFee

    The calculateFee method calculates and returns the fee that CSI will apply to a particular transaction.

  • calculatefee_nonNET

    The calculateFee_nonNET method calculates and returns the fee that CSI will apply to a particular transaction� the method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • calculatefee_nonNET_XMLObjectResponse

    The calculateFee_nonNET_XMLObjectResponse method calculates and returns the fee that CSI will apply to a particular transaction� the method is provided for those developers who are not using .NET and/or who wish to pass in an XML argument as a string, but, wish to have the response return as an System.xml.XMLDocument object.

  • export_checkCredits

    The export_checkCredits method provides a gateway through which CSI clients may request check credit history for updating their backend MIS and/or CIS systems.

  • export_checkReturns

    The export_checkReturns method provides a gateway through which CSI clients may request check return history for updating their backend MIS and/or CIS systems.

  • export_creditCardCredits

    The export_creditCardCredits method provides a gateway through which CSI clients may request credit card credit history for updating their backend MIS and/or CIS systems.

  • export_DetailedTransactions

    The export_DetailedTransactions method provides a gateway through which CSI clients may request detailed transaction history for updating their backend MIS and/or CIS systems.

  • export_DetailedTransactions_nonNET

    The export_DetailedTransactions_nonNET method provides a gateway through which CSI clients may request detailed transaction history for updating their backend MIS and/or CIS systems� this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • export_DetailedTransactions_Update

    The export_DetailedTransactions_Update method provides a gateway through which CSI clients may request detailed transaction history for updating their backend MIS and/or CIS systems that has not been provided in a previous update request (any transactions returned via this request will be flagged as updated and, subsequently, not be returned in future requests).

  • export_DetailedTransactions_Update_nonNET

    The export_DetailedTransactions_Update_nonNET method provides a gateway through which CSI clients may request detailed transaction history for updating their backend MIS and/or CIS systems that has not been provided in a previous update request (any transactions returned via this request will be flagged as updated and, subsequently, not be returned in future requests)�. this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • export_FeeStructure_CreditCards

    The export_FeeStructure_CreditCards method provides a gateway through which CSI clients may request the CSI credit card fee rates for local caching� this method is provided for those developers who do not wish to use the calculatedFee method during real-time calls.

  • processCredit

    The processCredit method provides a gateway through which CSI clients may process credits for erroneously processed electronic check and credit card transactions.

  • processCredit_nonNET

    The processCredit_nonNET method provides a gateway through which CSI clients may process credits for erroneously processed electronic check and credit card transactions� this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • processRecurringTransaction_ByToken

    The processRecurringTransaction_ByToken method provides a gateway through which CSI clients may process electronic credit card transactions utilizing a previously established credit card token value in place of actual credit card information.

  • processTransaction

    The processTransaction method provides a gateway through which CSI clients may process electronic check and credit card transactions.

  • processTransaction_nonNET

    The processTransaction_nonNET method provides a gateway through which CSI clients may process electronic check and credit card transactions� this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • processTransaction_nonNET_XMLObjectResponse

    The processTransaction_nonNET_XMLObjectResponse method provides a gateway through which CSI clients may process electronic check and credit card transactions� this method is provided for those developers who are not using .NET and/or who wish to pass in an XML argument as a string, but, wish to have the response return as an System.xml.XMLDocument object.

  • recurringTransaction_TokenCreation

    The recurringTransaction_TokenCreation method provides a gateway through which CSI clients may create a tokenized credit card record to be used for processing recurring credit card transactions.

  • test_nonNET

    The test_nonNET method accepts a simple string of less than 32 characters (any extra characters will simply be truncated) as an argument and returns the same string in reverse order� the method is provided for developers to utilize in order to quickly develop a simple proof of concept demonstrating SOAP connectivity and interaction with the CSI eCollections Portal.

  • verifyPaymentID

    The verifyPaymentID method provides a gateway through which CSI clients may verify locally (CSI) persisted payment ids. For this method to be effective the client must have established a method by which those payment ids are communicated to CSI for local persistence.

  • verifyPaymentID_nonNET

    The verifyPaymentID method provides a gateway through which CSI clients may verify locally (CSI) persisted payment ids. For this method to be effective the client must have established a method by which those payment ids are communicated to CSI for local persistence�. this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • verifyTransaction

    The verifyTransaction method provides a gateway through which CSI clients may verify that a transaction request processed successfully.

  • verifyTransaction_nonNET

    The verifyTransaction_nonNET method provides a gateway through which CSI clients may verify that a transaction request processed successfully� this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • VT_Transaction_GET

    The VT_Transaction_GET method allows CSI clients to securely retrieve transactional data that is the result of a previous virtual terminal transaction request.

  • VT_Transaction_GET_Manatron

    The VT_Transaction_GET_Mantron method allows CSI clients utilizing the Manatron MVP Tax Manager application to securely retrieve transactional data that is the result of a previous virtual terminal transaction request.

  • VT_Transaction_GET_Manatron_nonNET

    The VT_Transaction_GET_Mantron_nonNET method allows CSI clients utilizing the Manatron MVP Tax Manager application to securely retrieve transactional data that is the result of a previous virtual terminal transaction request� this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • VT_Transaction_POST

    The VT_Transaction_POST method allows CSI clients to securely post transactional data that is to be used in a subsequent virtual terminal transaction request.

  • VT_Transaction_POST_Manatron

    The VT_Transaction_POST_Manatron method allows CSI clients utilizing the Manatron MVP Tax Manager application to securely post transactional data that is to be used in a subsequent virtual terminal transaction request.

  • VT_Transaction_POST_Manatron_nonNET

    The VT_Transaction_POST_Manatron_nonNET method allows CSI clients utilizing the Manatron MVP Tax Manager application to securely post transactional data that is to be used in a subsequent virtual terminal transaction request� this method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • VT_Transaction_GET_nonNET

    The VT_Transaction_GET_nonNET method allows CSI clients to securely retrieve transactional data that is the result of a previous virtual terminal transaction request. This method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

  • VT_Transaction_POST_nonNET

    The VT_Transaction_POST_nonNet method allows CSI clients to securely post transactional data that is to be used in a subsequent virtual terminal transaction request. This method is provided for those developers who are not using .NET and/or who are not familiar with the System.xml.XMLDocument object.

Appendix B - Response Codes

Response CodeMeaning
Y######YThe request was successfully processed
YTESTEDYThe test was successful
N411111N : No Response From GatewayThe status of the transaction is unknown. Customer Service should be contacted to ensure proper management.
N511111N : �DeclineMessage�The transaction was declined. A description is provided in the �DeclineMessage�
N211111N : Missing Data ElementThe CLIENTKEY element (a required data element) was not provided in the XML submission.
N211112N : Missing Data ElementThe PAYMENTMETHOD element (a required data element) was not provided in the XML submission.
N211113N : Missing Data ElementThe CARDTYPE element (a required data element for Credit Card payments) was not provided in the XML submission.
N211114N : Missing Data ElementThe COLLECTIONMODE element (a required data element) was not provided in the XML submission.
N211115N : Missing Data ElementThe AMOUNT element (a required data element) was not provided in the XML submission.
N211116N : Missing Data ElementThe LINEITEM element (a required data element) was not provided in the XML submission (at least one must be present in a transaction)
N211117N : Missing Data ElementThe CUSTOMERPAYMENTTYPEID element (a required data element) was not provided in the XML submission
N211118N : Missing Data ElementThe ITEMAMOUNT element (a required data element) was not provided in the XML submission
N211119N : Missing Data ElementThe TRANSACTIONID element (a required data element) was not provided in the XML submission.
N211120N : Missing Data ElementThe AUTHFORCE element (a required data element for credit card transactions) was not provided in the XML submission.
N211121N : Missing Data ElementThe PRC element (a required data element for credit card 'force' transactions) was not provided in the XML submission.
N211122N : Missing Data ElementThe FEEAMOUNT element (a required data element) was not provided in the XML submission.
N211123N : Missing Data ElementThe NAME element (a required data element) was not provided in the XML submission.
N211124N : Missing Data ElementThe ADDRESS element (a required data element for AVS fraud protection or general Billing Information persistence) was not provided in the XML submission.
N211125N : Missing Data ElementThe ZIP element (a required data element for AVS fraud protection or general Billing Information persistence) was not provided in the XML submission.
N211126N : Missing Data ElementThe CVV2 element (a required data element for credit card transactions for specified collectionmodes) was not provided in the XML submission.
N211127N : Missing Data ElementThe CCNUMBER element (a required data element for credit card transactions) was not provided in the XML submission
N211128N : Missing Data ElementThe EXPDATE element (a required data element for credit card transactions) was not provided in the XML submission
N211129N : Missing Data ElementThe PAYMENTID element (a required data element) was not provided in the XML submission
N211130N : Missing Data ElementThe CHECKTYPE element (a required data element for eCheck transactions) was not provided in the XML submission
N211131N : Missing Data ElementThe CHECKNUMBER element (a required data element for eCheck transactions for specified collectionmodes) was not provided in the XML submission
N211132N : Missing Data ElementThe ROUTINGNUMBER element (a required data element for eCheck transactions) was not provided in the XML submission
N211133N : Missing Data ElementThe ACCOUNTNUMBER element (a required data element for eCheck transactions) was not provided in the XML submission
N211134N : Missing Data ElementThe PAYMENTID_SECONDARY element (defined as required by client business rules) was not provided in the XML submission
N211135N : Missing Data ElementThe CITY element (a required data element for AVS fraud protection or general Billing Information persistence) was not provided in the XML submission.
N211136N : Missing Data ElementThe STATE element (a required data element for AVS fraud protection or general Billing Information persistence) was not provided in the XML submission.
N211137N : Missing Data ElementThe COUNTRY element (a required data element for AVS fraud protection or general Billing Information persistence) was not provided in the XML submission.
N211138N : Missing Data ElementThe SHIPPINGNAME element (a required data element for shipping information persistence) was not provided in the XML submission.
N211139N : Missing Data ElementThe SHIPPINGPHONE element (a required data element for shipping information persistence) was not provided in the XML submission.
N211140N : Missing Data ElementThe SHIPPINGADDRESS element (a required data element for shipping information persistence) was not provided in the XML submission.
N211141N : Missing Data ElementThe SHIPPINGCITY element (a required data element for shipping information persistence) was not provided in the XML submission.
N211142N : Missing Data ElementThe SHIPPINGSTATE element (a required data element for shipping information persistence) was not provided in the XML submission.
N211143N : Missing Data ElementThe SHIPPINGZIP element (a required data element for shipping information persistence) was not provided in the XML submission.
N211144N : Missing Data ElementThe SHIPPINGCOUNTRY element (a required data element for shipping information persistence) was not provided in the XML submission.
N211145N : Missing Data ElementThe ACCOUNTTYPE element (a required data element for eCheck transactions) was not provided in the XML submission
N211146N : Missing Data ElementThe CHECKIMAGENAME element (a required data element for scanned eCheck transactions) was not provided in the XML submission
N211147N : Missing Data ElementThe IAT element (a required data element for eCheck transactions) was not provided in the XML submission
N211148N : Missing Data ElementThe PRC element (a required data element) was not provided in the XML submission.
N211149N : Missing Data ElementThe STARTDATE element (a required data element) was not provided in the XML submission.
N211150N : Missing Data ElementThe ENDDATE element (a required data element) was not provided in the XML submission.
N211151N : Missing Data ElementThe TOKENID element (a required data element) was not provided in the XML submission.
N211152N : Missing Data ElementThe PHONE element (a required data element) was not provided in the XML submission.
N211153N : Missing Data ElementThe TRACK2 element (a required data element) was not provided in the XML submission.
N211154N : Missing Data ElementThe DUKPT element (a required data element) was not provided in the XML submission.
N211155N : Missing Data ElementThe MPSTATUS element (a required data element) was not provided in the XML submission.
N211156N : Missing Data ElementThe MPDATA element (a required data element) was not provided in the XML submission.
N211157N : Missing Data ElementThe KSN element (a required data element) was not provided in the XML submission.
N211158N : Missing Data ElementThe ENCRYPTEDPINBLOCK element (a required data element) was not provided in the XML submission.
N211159N : Missing Data ElementThe CCNUMBERMASKED element (a required data element) was not provided in the XML submission.
N211160N : Missing Data ElementThe TOKEN element (a required data element) was not provided in the XML submission.
N311111N : Invalid DataThe CLIENTKEY value provided in the XML submit was not successfully validated
N311112N : Invalid DataThe PAYMENTMETHOD provided in the XML submit was not successfully validated
N311113N : Invalid DataThe CARDTYPE value provided in the XML submit was not successfully validated
N311114N : Invalid DataThe COLLECTIONMODE value provided in the XML submit was not successfully validated
N311115N : Invalid DataThe AMOUNT value provided in the XML submit was not successfully validated
N311116N : Invalid DataThe number of LINEITEM elements (a required complex data element) was invalid
N311117N : Invalid DataThe CUSTOMERPAYMENTTYPEID value provided in the XML submit was not successfully validated
N311118N : Invalid DataThe ITEMAMOUNT value provided in the XML submit was not successfully validated
N311119N : Invalid DataThe sum of the ITEMAMOUNT element values does not equal the overall AMOUNT element value
N311120N : Invalid DataThe TRANSACTIONID value provided in the XML submit was not successfully validated
N311121N : Invalid DataThe AUTHFORCE value provided in the XML submit was not successfully validated
N311122N : Invalid DataThe PRC value provided in the XML submit was not successfully validated
N311123N : Invalid DataThe FEEAMOUNT value provided in the XML submit was not successfully validated
N311124N : Invalid DataThe NAME value provided in the XML submit was not successfully validated
N311125N : Invalid DataThe ADDRESS value provided in the XML submit was not successfully validated
N311126N : Invalid DataThe CITY value provided in the XML submit was not successfully validated
N311127N : Invalid DataThe STATE value provided in the XML submit was not successfully validated
N311128N : Invalid DataThe ZIP value provided in the XML submit was not successfully validated
N311129N : Invalid DataThe CVV2 value provided in the XML submit was not successfully validated
N311130N : Invalid DataThe CCNUMBER value provided in the XML submit was not successfully validated
N311131N : Invalid DataThe EXPDATE value provided in the XML submit was not successfully validated
N311132N : Invalid DataThe NOTES value provided in the XML submit was not successfully validated
N311133N : Invalid DataThe CSIORGANIZATIONUNITID value provided in the XML submit was not successfully validated
N311134N : Invalid DataThe PAYMENTID value provided in the XML submit was not successfully validated
N311135N : Invalid DataThe EMAIL value provided in the XML submit was not successfully validated
N311136N : Invalid DataThe PHONE value provided in the XML submit was not successfully validated
N311137N : Invalid DataThe BANKNAME value provided in the XML submit was not successfully validated
N311138N : Invalid DataThe CHECKTYPE value provided in the XML submit was not successfully validated
N311139N : Invalid DataThe CHECKNUMBER value provided in the XML submit was not successfully validated
N311140N : Invalid DataThe ROUTINGNUMBER value provided in the XML submit was not successfully validated
N311141N : Invalid DataThe ACCOUNTNUMBER value provided in the XML submit was not successfully validated
N311142N : Invalid DataThe EFFECTIVEDATE value provided in the XML submit was not successfully validated
N311143N : Invalid DataThe PAYERID value provided in the XML submit was not successfully validated
N311144N : Invalid DataThe USERID value provided in the XML submit was not successfully validated
N311145N : Invalid DataThe PRC value provided in the cc 'force' XML submit was not successfully validated
N311146N : Invalid DataThe AMOUNT value provided in the cc 'force' XML submit was not successfully validated
N311147N : Invalid DataThe PAYMENTID_SECONDARY value provided in the XML submit was not successfully validated
N311148N : Invalid DataThe ADDRESSTWO value provided in the XML submit was not successfully validated
N311149N : Invalid DataThe COUNTRY value provided in the XML submit was not successfully validated
N311150N : Invalid DataThe SHIPPINGNAME value provided in the XML submit was not successfully validated
N311151N : Invalid DataThe SHIPPINGPHONE value provided in the XML submit was not successfully validated
N311152N : Invalid DataThe SHIPPINGEMAIL value provided in the XML submit was not successfully validated
N311153N : Invalid DataThe SHIPPINGADDRESS value provided in the XML submit was not successfully validated
N311154N : Invalid DataThe SHIPPINGADDRESSTWO value provided in the XML submit was not successfully validated
N311155N : Invalid DataThe SHIPPINGCITY value provided in the XML submit was not successfully validated
N311156N : Invalid DataThe SHIPPINGSTATE value provided in the XML submit was not successfully validated
N311157N : Invalid DataThe SHIPPINGZIP value provided in the XML submit was not successfully validated
N311158N : Invalid DataThe SHIPPINGCOUNTRY value provided in the XML submit was not successfully validated
N311159N : Invalid DataThe ACCOUNTTYPE value provided in the XML submit was not successfully validated
N311160N : Invalid DataThe CHECKIMAGENAME value provided in the XML submit was not successfully validated
N311161N : Invalid DataThe COLLECTIONMODE value provided in the XML submit is not valid for the PAYMENTMETHOD specified
N311162N : Invalid DataThe COUNTY value provided in the XML submit was not successfully validated
N311163N : Invalid DataThe ALLOWDUPLICATE value provided in the XML submit was not successfully validated
N311164N : Invalid DataThe IAT value provided in the XML submit was not successfully validated
N311165N : Invalid DataCredit Card payments are not allowed
N311166N : Invalid DataCredit Card payments are not allowed for the specified collection mode
N311167N : Invalid DataThe Credit Card type specified is not allowed for the specified collection mode
N311168N : Invalid DataDebit Card payments are not allowed
N311169N : Invalid DataDebit Card payments are not allowed for the specified collection mode
N311170N : Invalid DataCheck payments are not allowed
N311171N : Invalid DataCheck payments are not allowed for the specified collection mode
N311172N : Invalid DataThe INTERNALCREDIT value provided in the XML submit was not successfully validated
N311173N : Invalid DataThe CHARGEBACK value provided in the XML submit was not successfully validated
N311174N : Invalid DataThe STARTDATE value provided in the XML submit was not successfully validated
N311175N : Invalid DataThe ENDDATE value provided in the XML submit was not successfully validated
N311176N : Invalid DataThe PRC value provided in the XML submit represents a transaction that is currently in process (ACH Batch)
N311177N : Invalid DataThe PRC value provided in the XML submit does not represent an approved transaction in the CSI system
N311178N : Invalid DataThe PRC value provided in the XML submit represents a transaction that has a return (ACH return) that has yet to process
N311179N : Invalid DataThe PRC value provided in the XML submit has already been fully credited
N311180N : Invalid DataThe PRC value provided in the XML submit has a credit pending
N311181N : Invalid DataThe PRC value provided in the XML submit has been charged back (ACH return,etc)
N311182N : Invalid DataThe AMOUNT value provided in the XML submit is greater than the amount available for credit
N311183N : Invalid DataThe AMOUNT value provided in the XML submit does not equal the amount of the original transaction. For transactions representing multiple payment items, this value must be the same as the original transaction
N311184N : Invalid DataThe TOKENID value provided in the XML submit was not successfully validated
N311185N : Invalid DataNot currently used
N311186N : Invalid DataThe CCNUMBERMASKED value provided in the XML submit was not successfully validated
N311187N : Invalid DataThe TRACK2 value provided in the XML submit was not successfully validated
N311188N : Invalid DataThe DUKPT value provided in the XML submit was not successfully validated
N311189N : Invalid DataThe MPSTATUS value provided in the XML submit was not successfully validated
N311190N : Invalid DataThe MPDATA value provided in the XML submit was not successfully validated
N311191N : Invalid DataThe KSN value provided in the XML submit was not successfully validated
N311192N : Invalid DataThe ENCRYPTEDPINBLOCK value provided in the XML submit was not successfully validated
N611111N : Invalid Organization Unit IDThe Organization Unit ID provided does not exist in the CSI system
N611112N : Invalid Payment Type IDThe payment type id provided does not exist in the CSI system
N611113N : Invalid Payer IDThe payer id provided does not exist in the CSI system
N611114N : Invalid User IDThe user id provided does not exist in the CSI system
N611115N : Invalid Payment Type IDThe payment type id provided is currently set to in-active (cannot accept payments of this type) in the CSI system
N711111N : Duplicate PaymentA successful payment has been processed for the payment id provided within the specified duplicate prevention time constraint
N811111N : Excessive ACH ReturnsFor an ach item, too many returns have occurred in the past 12 months for a particular routing number \ account number
N881111N : NOC ViolationFor an ach item, there has been a NOC within the past 12 months for a particular routing number \ account number
N911111N : XML Load ErrorThe XML submit could not recognized as valid XML and, subsequently, could not be successfully loaded
N9#####N : General ErrorA general error occurred

Appendix C - Changes

'
Change Management Logs
DateDescription
10/11/2012Added data table for VT_TRANSACTION_GET
08/19/2012Name no longer a required field for VT_Transaction_Post. Added VT_Transaction_Post_nonNet and VT_Transaction_Get_nonNet methods.
6/14/2012Base-lined.
6/15/2012Added 'values' explanation for 'State' and 'Country' xml values stating that these values should be the full-name as opposed to abbreviations. If abbreviations are used, the drop down list boxes will not properly 'auto-select'� they will set to selected index = 0.
7/11/2012Added the UserField1 node to the Manatron VT POST XML submission specification.
7/31/2012Updated section 3.3 to add information concerning the querystring for URLSILENTPOST value and/or a URLRETURNPOST value.
11/13/2012Added Debit Card information to Card Type node.
01/03/2013Added VT Token Creation functionality (section 6)
02/20/2013Updated Appendix A to reflect lastest Sevice Descriptions.
03/27/2013Added DATENOW and TIMENOW to XML for section 3.5 XML Response � VT_Transaction_Get
Get Your Free Processing Quote or Workforce Today® Demo Now!

Find out just how much you can save on your processing or how easy it is to manage your workforce and payroll with JetPay!