Difference between revisions of "CreditLine Text Based / ICVerify Integration"
(→Generic Request Format) |
(→Hotel Request Format) |
||
Line 74: | Line 74: | ||
==Hotel Request Format== | ==Hotel Request Format== | ||
− | <[[#Message Type|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 /> | + | <[[#Message Type|Message Type]]>,<User ID>,<Not Used>,<Account Number>,<Exp Date ''+ Track Data (if available>''>,<Amount>,<Auth Code + Unique ID>''',<Guest Name>,<Checkin Date>,<Checkout Date>,<Room Rate>,"","",""'''<br /> |
''Notes:'' | ''Notes:'' |
Revision as of 14:42, 5 October 2007
This article is part of the Payment Processing Software Library |
|
Get it... | |
Install it... | |
Connect to it... | |
Set it up... | |
Learn to use it... | |
→ Manual & User Guide | |
Fix it... | |
→ Errors & Troubleshooting | |
Get Help... | |
More Info ... | |
See also... | |
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!
Contents
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
→ if you are having trouble, delete everything from the message directory and restart CreditLine server.
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 ;******************************************** ; ;Change the message directory used by the file based ICVerify protocol. ;Default: \911\MESSAGES ;MessageDir = \911\MESSAGES ;Change the file prefix for file based ICVerify messages. ;Default: ICVER ;ICVerifyMessagePrefix = MSG ;Change the type of file base ICVerify reponse for the .ANS file ;Default: YES - SET TO NO for VERBOSE ;ICVerifyShortResponse = NO ;Echo the Request in the .ANS file ;Default: NO ;ICVerifyEchoRequest=YES ;Change the network name used by the server component. ;Default: CCV_SRVR ;ServerName = CCV_SRVR ;******************************************** ; END FILE BASED (ICVERIFY) PROTOCOL SETTINGS ;********************************************
Also see Large Tracking ID support
Files
Request file name is ICVER???.REQ (??? is the terminal number)
Response file name is ICVER???.ANS
The prefix for the files is configurable through c:\911\data\911_CCV.INI file, see key ICVerifyMessagePrefix
Warning
The request file names must be UNIQUE . Duplication of request file names between two or more terminals may result in incorrect responses.
Request Format
Handling Track Data
Track 2 is preferred over Track 1 since it is shorter and consistent. For Track 1 data, CreditLine Credit Card Software will convert the lower case letters to upper case. This is due to some processors not allowing lower case letters in their messages. In general, you should pass whatever you get from the card reader.
Generic Request Format
<Message Type>,<User ID>,<Not Used>,<Account Number>,<Exp Date + Track Data (if available)>,<Amount>,<Auth Code + Unique ID>
- Message Type
- See Message Type for options
- User ID
- ???? Employee Number
- Exp Date
- yymm Year then month
- Amount
- ?????.?? Authorization Amount
- Auth Code
- ?????? 6 digit auth code
- Unique ID
- ???? 4 digit unique transaction number
Hotel Request Format
<Message Type>,<User ID>,<Not Used>,<Account Number>,<Exp Date + Track Data (if available>>,<Amount>,<Auth Code + Unique ID>,<Guest Name>,<Checkin Date>,<Checkout Date>,<Room Rate>,"","",""
Notes:
- The last three fields "","","" are reserved and must be present
Batch Commands
- "ST"
- batch
- "SP","Y","file_path 40"
- save batch report into file_path file
→ Note that the above batch report will not print under the CreditLine Demo Mode
Message Type
Credit Card
Type | Code |
---|---|
Auth | CA |
Book, Checkin | C4 |
Auth Only | C6 |
Sale | C1 |
Force, Voice Auth | C5 |
Credit | C3 |
Void Sale | C2 |
Void Credit | CR |
Add Tip, Edit, Finalize | CT |
Post, Ship, Checkout | CO |
Extend Stay | CI |
No Show | CN |
Add Charge | CG |
Settle | ST |
Settle and Print Batch Report | SP |
Gift Card
Type | Code |
---|---|
Inquiry | GI |
Activation | GA |
Deactivation | GD |
Adjust | GJ |
Verification
If using the format for the export function: after the export check the export file to ensure that all the transactions have been successfully processed.
Response Format
Approval
<Y + Auth Code + Unique ID>
Approval Example
Yauth010040
- Y=approved
- auth01=Auth code
- 0040=unique transaction number
Large Tracking ID
→ This is an optional extension to the standard format. Note: This changes the response that you will receive from CreditLine
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:
[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: "Y1234561002"