Revision as of 15:53, 14 March 2006

CreditLine Payment Processing Software Integration. This site can also be reached at http://docs.911software.com

→ Looking for better rates?   Get a Free Credit Card Processing Cost Comparison!

This guide is for developers using the file based communication method. While API communication using the DLL is the preferred integration method, file based communication is a good alternative that is easy to implement. The format is the same as that of ICVerify.

Communication Directory

Directory for message exchange is c:/911/messages<br\> Directory is configurable through c:\911\data\911_CCV.INI file: see key MessageDir

Protocol Settings

See the following entries in c:\911\data\911_CCV.INI

Note: Do not forget to remove ';' in front of a key to uncomment it; for the key to take effect.

→ Restart CreditLine Server for the new settings to take effect.

;********************************************
 ; FILE BASED (ICVERIFY) PROTOCOL SETTINGS<br /> ;********************************************<br /> ;<br /> ;Change the message directory used by the file based ICVerify protocol.<br /> ;Default: \911\MESSAGES<br /> ;MessageDir = \911\MESSAGES<br /><br /> ;Change the file prefix for file based ICVerify messages.<br /> ;Default: ICVER<br /> ;ICVerifyMessagePrefix = MSG<br /><br /> ;Change the type of file base ICVerify reponse for the .ANS file<br /> ;Default: YES - SET TO NO for <font color="#008000">'''VERBOSE'''</font> <br /> ;ICVerifyShortResponse = NO<br /><br /> ;Echo the Request in the .ANS file<br /> ;Default: NO<br /> ;ICVerifyEchoRequest=YES<br /><br /> ;Change the network name used by the server component.<br /> ;Default: CCV_SRVR<br /> ;ServerName = CCV_SRVR<br /><br /> ;********************************************<br /> ; END FILE BASED (ICVERIFY) PROTOCOL SETTINGS<br /> ;********************************************

=Files=

Request file name is <font color="#800000">ICVER???.REQ </font>(??? is the terminal number)<br /> Response file name is <font color="#800000">ICVER???.ANS </font><br /> The prefix for the files is configurable through c:\911\data\911_CCV.INI file, see key ICVerifyMessagePrefix

=Request Format=

==Generic Request Format==

<Message Type>,<User ID>,<Not Used>,<Account Number>,<Exp Date + Track Data>,<Amount>,<Auth Code + Unique ID><br />  

{| border="1" cellpadding = "5"
! style="background:#efefef;" | Message Type
! style="background:#efefef;" | Code
|-
| Auth
| C1 
|-
| Void
| C2
|-
| Credit/Refund/Return
| C3
|-
| Sale
| C4 
|-
| Edit
| CT
|-
| Auth Only/Pre-Authorization
| CA
|-
| Force/Post-Authorization
| C5
|-
| Finalize: converts Auth to Sale (C + letter "O")
| CO
|}

<br /> User ID:<br /> ???? Employee Number<br /><br /> Exp Date:<br /> yymm Year then month<br /><br /> Amount:<br /> ?????.?? Authorization Amount<br /><br /> Auth Code:<br /> ?????? 6 digit auth code<br /><br /> Unique ID:<br /> ???? 4 digit unique transaction number<br />  

==Hotel Request Format==

<Message Type>,<User ID>,<Not Used>,<Account Number>,<Exp Date + Track Data>,<Amount>,<Auth Code + Unique ID>''',<Guest Name>,<Checkin Date>,<Checkout Date>,<Room Rate>,"","",""'''<br />

''Notes:''
*The last three fields '''"","",""''' are reserved and must be present
*See [[#Generic Request Format|Generic Request Format]] for decription of other fields

=Response Format=

== Approval ==

<Y + Auth Code + Unique ID><br />

===Approval Example===
'''Y''auth01''0040'''

:Y=approved
:auth01=Auth code
:0040=unique transaction number


===Large Tracking ID (Optional)===
CreditLine supports large Unique Tracking ID's as an extension of ICVerify format

To enable large Unique Tracking ID's and use the following switch in '''c:\911\data\911_ccv.ini''':
'''
<pre>
[SeqNum
;Maximum Transaction Number
;The number specifies the maximum transaction number before it rolls over and start with 1
;Default=10000. 
;TransNumMod=100000000

Remove leading ; from the bottom line like so:

TransNumMod=100000000

→Restart the CreditLine Server to apply.

If enabled the following format will be returned: For instance in the following response:

Yauth0100400000

Y=approved

auth01=Auth code

0040=lower 4 digits of the transaction number

0000=upper 4 digits of the transaction number

Decline

<N + Message>

Examples

Generic Examples

Auth with Manual Entry

"CA","0001","","4111111111111111","0212","1.00",""
Note: Employee number is 0001, account number is 4111111111111111, exp date is Dec '02 and auth amount is $1.00.

Auth response with Approval

"Y1234560001"
Note: Y indicates approval. 123456 is the auth code. 0001 is the returned unique transaction number.
There are no spaces between fields.

Auth with Mag Stripe

"CA","0001","","4111111111111111","0212B4111111111111111^TEST/CARD^0212201000000","2.00",""
Note: There is no space between exp date and track data.

Auth response with decline

"NCALL CENTER"
Note: N indicates decline. Show message 'CALL CENTER' to the user.

Force with manual entry

"C5","0001","","4111111111111111","0212","1.00","123456"
Note: 123456 is the auth code.

Void

"C2","0001","","4111111111111111","","0.00","0000001234"
Note: 000000 is the auth code filler. 1234 is the unique transaction number.

Edit

"CT","0001","","4111111111111111","","3.00","0000005678"
Note: 3.00 is the final amount to be sent to the processor.

Hotel Examples

"C4","~ ~PA","040626","37xxxxxxxxxx008","0603","258.00","0402","","Robert Lincoln","20040305","20040306","215.00","","",""

"CO","~ ~LD","040626","37xxxxxxxxxx008","0603","246.3","0402","","Robert Lincoln","20040305","20040306","215.00","","",""

"CO","~ ~KV","040626","37xxxxxxxxxx008","0603","19.37","Z402","","Robert Lincoln","20040305","20040306","0.00","","",""

• "Robert Lincoln" is guest name
• "20040305" is the check in date.
• "20040306" is the check out date.
• "215.00" is the room rate.
• See Generic Examples for more patterns

Complete Turnaround Example

POS → 911: "CA","0001","","4111111111111111","0212","1.00",""
911 → POS: "Y1234561001"
POS → 911: "CT","0001","","4111111111111111","","3.00","0000001001"
911 → POS: "Y1234561001"

Also See

ICVerify SDK Format Spec