|
|
(45 intermediate revisions by 2 users not shown) |
Line 1: |
Line 1: |
| {{CreditLine Header|Integration Guide}} | | {{CreditLine Header|Integration Guide}} |
| | | |
− | =Integration Basics= | + | =Integration Options= |
| + | ==Integration Languages== |
| + | There are several integration options for Creditline: |
| + | #DLL for C#, C++, et |
| + | #Java Wrapper for Java |
| + | #OCX for Visual Basic, dotNet, etc |
| + | #Encrypted Text Import for manual batch processing. |
| | | |
− | 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.
| + | ==Integration Styles== |
| + | There are three major integration styles, all of which may use the optional Tokenization API. |
| + | #→ (recommended) Integrator uses CreditLine supplied UI (UI Encapsulation). This is '''clcUI PCI Friendly Option''' |
| + | #Integrator provides their own UI |
| + | #Integrator uses Encrypted Text Import for manual batch processing |
| | | |
− | The basic operation is as follows:
| + | ==EMV Payment Terminal Support== |
| + | EMV Payment Terminal Support is provided by our next generation platform, Cloud9 Payment Gateway. CreditLine works transparently with Cloud9 Services via Cloud9 Passthrough Interface. |
| + | <br> |
| + | Please, see [http://cloud9paymentgateway.com/w/index.php?title=Payment_Processing_User_Setup_Guide#Supported_Hardware EMV Payment Terminals Guide] '''(note: this link will take you to Cloud9 Documentation Suite)'''. |
| | | |
− | ==Initialization== | + | =Quick Start Guide= |
− | ;'''<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).
| + | This is the best place to get started with your integration:<br>'''→[[QuickStart Integration Guide]]''' |
− | | + | |
− | 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'''.
| + | |
− | | + | |
− | ==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.
| + | |
− | | + | |
− | ==.NET==
| + | |
− | → Note: for .NET please use '''clccs.dll''' and '''CLCAPIW2.dll''' in '''\911\BIN''' directory.
| + | |
− | | + | |
− | ===C#===
| + | |
− | [http://www.911software.com/files/samples/dotNET/C_Sharp/ .NET C# Sample]
| + | |
− | | + | |
− | ===Visual Basic===
| + | |
− | [http://www.911software.com/files/samples/dotNET/VB/ Visual Basic .NET Samples]
| + | |
− | | + | |
− | ==Legacy==
| + | |
− | | + | |
− | ===C++===
| + | |
− | *[http://www.911software.com/files/samples/CPP Visual C++ MFC Sample]
| + | |
− | | + | |
− | ===Visual Basic===
| + | |
− | *[http://www.911software.com/files/samples/VB Legacy Visual Basic Form Samples]
| + | |
− | | + | |
− | =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 Full Advanced Logging]
| + | |
− | | + | |
− | =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]] |
There are three major integration styles, all of which may use the optional Tokenization API.
EMV Payment Terminal Support is provided by our next generation platform, Cloud9 Payment Gateway. CreditLine works transparently with Cloud9 Services via Cloud9 Passthrough Interface.
Please, see EMV Payment Terminals Guide (note: this link will take you to Cloud9 Documentation Suite).