|
|
| Line 9: |
Line 9: |
| | {{PCI Exempt API Intro}} | | {{PCI Exempt API Intro}} |
| | For more info, please see '''[[PCI Friendly API]]'''. | | For more info, please see '''[[PCI Friendly API]]'''. |
| − |
| |
| − | = Rush Approval Mode =
| |
| − | Rush Approval Mode is an optional transparent offline mode that allows POS to continue taking credit cards without delays during connectivity failures.
| |
| − | For more information see [[Rush Approval Mode]] article. Requires 3.03.14Alpha6+
| |
| − |
| |
| − | =Card Storage=
| |
| − |
| |
| − | [[PCI Friendly API]] also offers a comprehensive set of payment info storage API.
| |
| − |
| |
| − | =Integration Basics=
| |
| − |
| |
| − | Your Point Of Sale will drive our CreditLine Server through the Application Programming Interface (API). The API can be made available to the application through one of the methods described below.
| |
| − |
| |
| − | The basic operation is as follows:
| |
| − |
| |
| − | ==Initialization==
| |
| − | ;'''<font color="#800000">Initialize</font>''':sets the local path to the server data directory here. Every client can actually use a different data path for advanced configurations (e.g. every client batches their own transactions separately).
| |
| − |
| |
| − | Here you will set:
| |
| − | #'''Client Name''', that has to be '''unique''' for every terminal
| |
| − | #'''Server Directories''', which are actual directories on the server where the dll is installed). These two are required.
| |
| − |
| |
| − | ==Transaction Processing==
| |
| − |
| |
| − | ===Fine Dining Restaurants (Tip Environment)===
| |
| − |
| |
| − | ;'''<font color="#800000">1) Auth</font>''':Every card (Configuration->Authorization Configuration->Visa->Edit) has a field <font color="#008000">'''''Tip Rate'''''</font>. By default it is set to 20%. When using <font color="#800000">'''Auth'''</font> call, the server does an automatic authorization for the main amount plus 20% to account for a possible tip. This will make sure that the money is already reserved, so that when the server adds tip at the end of the day the card does not decline. If you '''<font color="#008000">''do not use Tips'' </font>'''in your environment or to disable, set <font color="#008000">'''''Tip Rate'''''</font> to 0 for every card.
| |
| − | '''''IMPORTANT: ''<font color="#008000">''Auth''</font>''' transaction (a transaction created with '''<font color="#800000">Auth</font>''') will not '''<font color="#008000">Batch'' ''</font>'''
| |
| − | until it is <font color="#008000">'''[[Transaction Finalization|Finalized]]. '''</font>(see <font color="#008000">'''AddTip'''</font> below).
| |
| − |
| |
| − | ;'''<font color="#800000">2) AddTip</font>''': will overwrite any previously set Tip value, including the one preset by Authorize. Pass the '''<font color="#008000">Tracking Id</font>''' created by Authorize to this function. This call will '''<font color="#008000">[[Transaction Finalization|Finalize]]</font>''' the <font color="#008000">'''''Auth '''''</font> transaction<font color="#008000">'''''. '''''</font>This means that it will turn the '''''<font color="#008000">Auth</font>''''' transaction into ''<font color="#008000">'''Sale '''</font>'' transaction, which in turn will include it in the next <font color="#008000">'' '''Batch. '''''</font>
| |
| − |
| |
| − | '''''IMPORTANT:''''' the '''<font color="#008000">Tracking Id </font>'''returned by '''<font color="#800000">Auth </font>'''must match the one supplied to '''<font color="#800000"> AddTip</font>''',
| |
| − | otherwise two transactions will be generated in the journal (one Auth transaction and one Sale transaction ).
| |
| − | This will create <font color="#008000">'''''Auth '''''</font>transactions in the journal that will not be batched.
| |
| − | If you are generating your own '''<font color="#008000">Tracking Id</font>'''s please make sure that they match on
| |
| − | '''<font color="#008000">Finalization </font>'''to avoid serious transaction problems.
| |
| − |
| |
| − | ===Retail and QSR (No-Tip Environment)===
| |
| − |
| |
| − | ;'''<font color="#800000">Sale</font>''': creates a sale transactions that is ready for batching. You can also include tip if desired in the sale if it is a one step process. Do not use '''<font color="#800000">Auth</font>''' if you do not use tips in this environment!
| |
| − |
| |
| − |
| |
| − | ''Repeat the [[#Transaction Processing|Transaction Processing]] step as necessary''
| |
| − |
| |
| − | ==Settlement==
| |
| − | ;<font color="#800000">Batch</font>
| |
| − | :This call will instruct the processor to deposit the money (allocated by <font color="#800000">'''Authorize, Add Tip '''</font>and/or <font color="#800000">'''Sale '''</font>as described in Step 2. above) into the bank account. Only <font color="#008000">'''''Finalized'' '''</font>transactions will be included in the <font color="#800000">'''Batch. '''</font> The rest of transactions will be left in the journal. '''<font color="#800000"> </font>'''Most merchants <font color="#800000">'''Batch '''</font>daily.
| |
| − |
| |
| − | '' Repeat [[#Transaction Processing|Transaction Processing]] and [[#Batch|Batch]] steps as necessary''
| |
| − |
| |
| − | ==Clean Up==
| |
| − | ;<font color="#800000">Shutdown</font>:This call will shutdown and clean up the connection
| |
| − |
| |
| − | ==Other Functions==
| |
| − | Other calls include '''Void, Credit, Selective Batch''', etc. Please [[#Platform Specific API Guides|Platform Specific API Guides]] below for complete listing.
| |
| − |
| |
| − | =Important Programming Rules=
| |
| − | {{Template:CreditLine Programming Rules}}
| |
| − |
| |
| − | =Multiple Terminal Setup=
| |
| − | [[Image:MultipleTerminals.jpg|none|framed]]
| |
| − |
| |
| − | =Platform Specific API Guides =
| |
| − | ==DLL API (Preferred)==
| |
| − | *[[CreditLine DLL API Integration|API Guide for DLL Based Communication]] - '''Preferred Integration Method'''
| |
| − | ==Text Based (ICVerify compatible)==
| |
| − | *[[CreditLine_Text_Based_/_ICVerify_Integration|File Based/ICVERIFY Communication Guide]]
| |
| − | ==ATL COM for Visual Basic, .NET, ASP, web etc==
| |
| − | *[[CreditLine COM Integration|ATL COM Integration Guide]]
| |
| − |
| |
| − | ==OCX for Visual Basic==
| |
| − | *[[CreditLine OCX Integration|OCX Integration Guide for Visual Basic]] - '''This is a legacy interface, please use ATL COM Integration Guide ABOVE'''.
| |
| − | ==JAVA Wrapper==
| |
| − | *[[Java Wrapper]]
| |
| − |
| |
| − | ==Import/Export==
| |
| − | *[[CreditLine Import/Export|Import/Export Guide]]
| |
| − | ==Micros==
| |
| − | *[[CreditLine Micros POS Integration]]
| |
| − |
| |
| − | =Samples=
| |
| − | → Some samples include DLL's for your convenience. For the production work, please update the DLL's with the latest provided in your software install under '''\911\BIN''' directory.
| |
| − |
| |
| − | * '''[http://www.911software.com/files/samples/ Samples Directory]'''
| |
| − |
| |
| − | =Advanced Setup=
| |
| − | {{CreditLine Advanced Setup}}
| |
| − |
| |
| − | = Complete List of Functions =
| |
| − |
| |
| − | === DLL ===
| |
| − |
| |
| − | Please see '''<font color="#008000">911\bin\CLCAPIW.h</font>'''
| |
| − |
| |
| − | '''NOTE: ''' OCX/COM/ATL objects simply wrap the standard API DLL, removing "clc" prefix from functions.
| |
| − |
| |
| − | =Testing & Troubleshooting=
| |
| − | ==Testing==
| |
| − | *[[CreditLine VITAL Test Account]]
| |
| − | *[[CreditLine Demo Mode]]
| |
| − | *[[CreditLine Test Mode]]
| |
| − |
| |
| − | ==Logging==
| |
| − | *[[CreditLine_Troubleshooting#Logging|CreditLine Logging]]
| |
| − | *[[CreditLine_Troubleshooting#API_Logging|API Logging]]
| |
| − | *[http://911software.com/dealerwiki/index.php?title=Advanced_Logging Trace Mode:Full Advanced Logging]
| |
| − |
| |
| − | ==Support Request==
| |
| − | For support, please follow the [[CreditLine_Troubleshooting#Support_Request|Dealer Support Request Procedure]].
| |
| − |
| |
| − | =Certification=
| |
| − |
| |
| − | ==Scripts==
| |
| − | You can use the following scripts to test your POS integration with 911 Software:
| |
| − | ;[http://911software.com/files/test/scripts/ Certification Scripts] (after opening the link, please use right click and Save Target As to avoid download delays)
| |
| − |
| |
| − | ==Test Accounts==
| |
| − | Make sure to set the CreditLine into [[CreditLine Test Mode]] when using these test accounts:
| |
| − | ;[http://911software.com/files/test/ Merchant Test Accounts]
| |
| − |
| |
| − | =Also See=
| |
| − | *[[CreditLine Script|Guide to Scripting CreditLine]] - useful for testing
| |
| − | *[[CreditLine VITAL Test Account]]
| |
| | | | |
| | [[Category:CreditLine Integration|Integration Guides]] | | [[Category:CreditLine Integration|Integration Guides]] |
PCI Council PA-DSS and other security standards place stringent requirements on Point Of Sale software. You have an option to make your code "PCI Friendly" by using both secure tokens and/or external payment info input encapsulation.
There are three ways, in which CreditLine can help your application eliminate exposure to the payment info:
This way your application can claim that no credit card data is being stored or processed.
All aspects of the UI can be customized
