Revision as of 22:30, 24 February 2006

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

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

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

Initialize. Set 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)

Transaction Processing

Restaurants Only

• 1) Auth. Note: Every card (Configuration->Authorization Configuration->Visa->Edit) has a field Tip Rate. By default it is set to 20%. When using Auth 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 do not use Tips in your environment or to disable, set Tip Rate to 0 for every card.

 IMPORTANT: Auth transaction (a transaction created with Auth) will not Batch until it is Finalized. (see AddTip below). 

• 2) AddTip. (Restaurants Only) Actually, this call sets the tip. AddTip will overwrite any previously set Tip value, including the one preset by Authorize. Pass the Tracking Id created by Authorize to this function. This call will Finalize the Auth transaction. This means that it will turn the Auth transaction into Sale transaction, which in turn will include it in the next Batch.

 IMPORTANT: the Tracking Id returned by Auth must match the one supplied to  AddTip,
 otherwise two transactions will be generated  in the journal (one Auth transaction  and one Sale transaction ).
 This will create Auth transactions in the journal that will not be batched.  
 If you are generating your own Tracking Ids please make sure that they match on 
 Finalization to avoid serious transaction problems.

Retail (no-tip environment)

Sale. 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.

       Repeat the Transaction Processing step as necessary

Batch

This call will instruct the processor to deposit the money (allocated by Authorize, Add Tip and/or Sale as described in Step 2. above) into the bank account. Only Finalized transactions will be included in the Batch. The rest of transactions will be left in the journal. Most merchants Batch daily.

       Repeat Transaction Processing and Batch steps as necessary

Shutdown

This call will shutdown and clean up the connection

Other Functions

Other calls include Void, Credit, Selective Batch, etc. Please API Guides below for complete listing.

Fine Tuning

CreditLine behavior can be fine tuned to match your operational requirements.

Please see the in 911/data/911_CCV.INI for more information.

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

Complete List of Functions

DLL

Please see 911\bin\CLCAPIW.h

 NOTE:  OCX/COM/ATL objects simply wrap the standard API DLL, removing "clc" prefix from functions. 

Platform Specific API Guides<

• API Guide for DLL Based Communication - Preferred Integration Method
• File Based/ICVERIFY Communication Guide
• OCX Integration Guide for VisualBasic
• COM Integration Guide
• Web Page Integration Guide ( ASP, .NET, etc )
• Import/Export Guide
• CreditLine Micros POS Integration