qmerchant manual 15 - qbautomation · debug mode: in debug mode, all message to and from quickbooks...
TRANSCRIPT
1 QMerchantManual
August27,2019
QMerchantManual
Version15.0
Thisdocumentreflectsversion15.0.0ofQMerchant.Someofthescreenshotsarejustexamplesandmaydifferfromtherealproduct.QBAutomationisatrademarkandservicemarkofRHAV.addQinisatrademarkandservicemarkofRHAV.QuickBooksisaregisteredtrademarkandservicemarkofIntuitInc.intheUnitedStatesandothercountriesAuthorize.NetisaregisteredtrademarkofLightbridge,Inc.Allothermarksarethepropertyoftheirrespectiveowners.Copyright©2002–2019byRHAVAllrightsreserved.
2 QMerchantManual
August27,2019
TableofContents
INSTALLATION........................................................................................................................4 PREPARATIONFORUSEWITHQUICKBOOKS(DESKTOPVERSIONS)...................................................9 SETUPFORUSEWITHQUICKBOOKS(DESKTOPVERSIONS)............................................................10 SETUPFORUSEWITHQUICKBOOKSPOINT-OF-SALE...................................................................11 STARTUSINGQMERCHANT....................................................................................................13 SETTINGS............................................................................................................................14 KEYBOARDSHORTCUTS..........................................................................................................18 MULTIPLEMERCHANTACCOUNTS...........................................................................................20 USEQMERCHANTASVIRTUALTERMINALWITHOUTQUICKBOOKS.............................................21 USEQMERCHANTWITHQUICKBOOKSPRO,PREMIERE,ENTERPRISE............................................23 WORKINGWITHSALESRECEIPTS.............................................................................................24 USEOFCHECKS....................................................................................................................28 WORKINGWITHINVOICES/RECEIVEPAYMENTS........................................................................29 WORKINGWITHSALESORDERS...............................................................................................31 WORKINGWITHCREDITMEMO..............................................................................................32 RECURRINGBILLING..............................................................................................................33 BATCHPROCESSING(‘UNATTENDEDMODE’)............................................................................36 BEHAVIOROFTHEGETPAYMENTBUTTON................................................................................37 USEQMERCHANTWITHQUICKBOOKS–POINTOFSALE.............................................................39 VOIDS,CREDITSANDREFUNDS...............................................................................................43 QUICKMODE.......................................................................................................................44 SERVERINSTALLATIONANDMANAGEMENT...............................................................................45 LEVELIIDATA......................................................................................................................46 LEVELIIIDATA.....................................................................................................................47 CIM(AUTHORIZE.NETCUSTOMERINFORMATIONMANAGEMENT)........................................48 USEOFMAGNETICSTRIPEREADERS........................................................................................50 QMERCHANTMENUENTRIES.................................................................................................51 THELOGFILE.......................................................................................................................53 TRANSACTIONTYPESANDOTHERCODES...................................................................................54 PRINTRECEIPT.....................................................................................................................55 CHANGETHEPRINTRECEIPT....................................................................................................55 BARCODEPRINTING..............................................................................................................57 RECEIPTFORMATTINGPARAMETERSANDCOMMANDS................................................................57 RE-PRINTARECEIPT..............................................................................................................58 CUSTOMSETTINGS................................................................................................................59 REPORTS.............................................................................................................................64 ACTIVATION.........................................................................................................................65 PAYMENTGATEWAYS............................................................................................................66 AUTHORIZE.NETAPILOGINIDANDTRANSACTIONKEY..............................................................67 TIPS....................................................................................................................................68 TESTYOURCONNECTIONTOTHEPAYMENTPROVIDER:................................................................68
3 QMerchantManual
August27,2019
GETTHEQMERCHANTVERSIONANDSERIALNUMBER.................................................................68 TROUBLESHOOT...................................................................................................................69 Prerequisites....................................................................................................................69 HowdoIgetthetransactionkeyfromAuthorize.Net?...................................................69 IseethefollowingmessagefromAuthorize.Net.............................................................69 SupportedPaymentGateways:........................................................................................69 HowcanIseetheauthorizationandtransactionidofasalesreceipt?...........................69 CannotgetthecreditcardnumberfromQuickBooks.....................................................70 QuickBooksDesktopVersionsi.e.EnterpriseandWindows7.........................................70 HowcanIdisabletheintegratedQuickBooksmerchantservice?...................................70 Errormessage‘Markettypeisinvalid..............................................................................71 IwanttochangetheQuickBooksversionIselectedduringinstallation..........................71 APPENDIXA:SCREENSHOTSFORTHEUSEWITHQUICKBOOKSPOINT-OF-SALE(OLDERVERSIONS)......72 APPENDIXB:AUTHORIZE.NETRESPONSECODES(EXCERPTFROMAUTHORIZE.NETDOCUMENTATION)75
4 QMerchantManual
August27,2019
INSTALLATIONAfterdownload,pleaserunthedownloadedexecutable.
Step1:Thefollowingdialogappears.
Step2:Click’Next’tocontinue.
TheRHAVlicenseagreementisdisplayed.Youmustacceptthelicense,otherwiseyoucannotuseQMerchant.
5 QMerchantManual
August27,2019
Step3:Confirmtheinstallationfolder.Werecommendleavingitasitisandclick‘Install’tocompletetheinstallation.
6 QMerchantManual
August27,2019
Step4:FinishtheinstallationandlaunchQMerchant.
Step5:Usethesetupwizard.
Thesetupisatwo-stepprocess.FirstwesetupyourQuickBooksconnectionandthenweestablishtheconnectiontotheselectedpaymentprovider.
PleaseselectyourQuickBooksversionandclickcontinue.QMerchanttriestoconnecttoQuickBooks. If this is thefirsttimeyouinstallQMerchant,somedialogswillappear(asdescribedinthefollowingchapter).Pleaserespondtothosedialogs.
Aftertheconnectionissuccessful,thenpleaseselectyourpaymentgateway.Thefollowingselectionsarecurrentlyavailable:
Authorize.net YouneedtheAPILoginIDandthetransactionkey.Yougetbothfromtheauthorize.net
merchantwebsiteundersecuritysettings.
PPI YouneedanAccountToken.PleaseaskPPIPaymoverforit.Other
Youaregoingtouseoneoftheothersupportedpaymentgateways.Pleasefollowthein-structionsandsetitupviatheQMerchantsettingsdialog.
Iwillsetupthepaymentproviderlater
PleasedefinethepaymentgatewayviatheQMerchantsettingsdialog
Nowenterthecredentialsyourpaymentprovidergaveyou.
7 QMerchantManual
August27,2019
BelowisascreenshotofasuccessfulsetupforaQuickBooksdesktoporserverversionandauthorize.net.
HereisascreenshotofasuccessfulsetupforaQuickBooksPoint-of-SaleandPPI.
Ifweareable toestablish the connection to yourpaymentprovider, youare ready touseQMerchant.Press the‘ReadytouseQMerchant’buttontoclosethewizard.Pleasereviewyoursettings,connecttoQuickBooksandstartwithQMerchant.
8 QMerchantManual
August27,2019
Ifyourpaymentproviderisnotlisted,pleaseselectOTHER.FromtheQMerchantdashboardclickSettings
Andenterthepaymentproviderinformation.
After installationyousee the following icon atyourdesktop.Also there isanentry inyourProgramsMenunamedQMerchant.Toruntheapplication,double-clickthaticon.
IfyouchoosetouninstallQMerchant,youcandothiseitherfromtheprogrammenuorviatheControlPanel-Unin-stallPrograms.
9 QMerchantManual
August27,2019
PREPARATIONFORUSEWITHQUICKBOOKS(DESKTOPVERSIONS)OpenyourQuickBooksapplication.TheninvokefromthemenuEdit|Preferences.ChooseIntegratedApplicationsandtheCompanyPreferencestab.
Makesurethatthe"Don'tallowanyapplicationtoaccessthiscompanyfile"isun-checked.
10 QMerchantManual
August27,2019
SETUPFORUSEWITHQUICKBOOKS(DESKTOPVERSIONS)OpenQuickBooks.Youwillbeaskedtoauthorizeourapplication(This isaone-timeprocess).QMerchantrequestsac-cesstoQuickBooks.ThefollowingQuickBooksmessage-orsimilarforQuickBooksPointofSale-appears:
Pleasecontinueas indicatedwith 'Yes,wheneverthisQuickBookscompanyfile isopen'anddon't forgettocheckthe'Allow....'checkbox.Thisisnecessary,becausewewillaccess/modifythecustomercreditcardinformation.Aconfir-mationdialogwillappear
Confirmwith'Done'andthenextdialogwithYes.
11 QMerchantManual
August27,2019
SETUPFORUSEWITHQUICKBOOKSPOINT-OF-SALEPlease loginasSysAdminandmakesure thatQuickBooksPoint-of-Sale is innetworkmode.Youcanget thisdialog inPOS from the Filemenu and then CompanyOperations (older versions) or ‘Switch company file tomultiusermode’.QMerchantactslikeanadditionalworkstationtoPOS
WhenQMerchanttriestoaccessQuickBooksPoint-of-SaleforthefirsttimeduringthesetupdialogorwhenyouconnecttoQuickBooks,youseethefollowingdialogsequence:
QMerchantlooksforavailablePoint-of-Saleserverstoconnectto.
Afteraserverisfoundorselected,youmustgiveQMerchantthepermissiontoaccessPOS.Pleasechoose‘Yes,Always’.
12 QMerchantManual
August27,2019
ThenafterashortperiodoftimetheQMerchantdashboardshowsthatitisconnectedtoQuickBooksandyoucanstarttoprocesspayment.
Pleasecontinuewiththesection‘UseQMerchantwithQuickBooksPoint-of-Sale’.
13 QMerchantManual
August27,2019
STARTUSINGQMERCHANTFromtheDashboardpresstheyellowbutton‘ConnecttoQuickBooks’.
Bydoingthat,aconnectiontoQuickBooksisestablished.
TheDashboardthenlookslikethis:
14 QMerchantManual
August27,2019
SETTINGSOpentheSettingsdialog(theboxinthelowerleft).
Thepictureaboveshowsanexampleforauthorize.netsettings.Pleasereadtheexplanationsbelow.
IfyouworkwithQuickBooksPoint-of-Sale,theQuickBooksSettings(rightside)arenotvisiblebecausethatisdoneau-tomatically.
Therearesomespecialsettingsavailableviathemenuentry‘Special’
1.Itemized:Ifcheckednotonlythetotalsbutalsothesingleitemsaresendtothepaymentprovider.Thisoptionisnotavailableforallpaymentproviders.
2.DebugMode:Indebugmode,allmessagetoandfromQuickBooksarerecordedinalogfile.Werecommendtousethisonlyonadvicebyoursupportteam.
3.MultipleMerchantAccounts:Enablestheusageofseveraldifferentmerchantaccountswiththesameofwithdiffer-entpaymentproviders.
4.AllowBatchProcessing:Enablestheprocessofaseriesofpaymentsinunattendedmode(authorize.netonly).
5.Level3:Level3transactionmode(PayTraceonly).
15 QMerchantManual
August27,2019
Thefieldshavethefollowingmeaning:
ProviderInformation
PaymentGatewayProvider
Selectoneoftheimplementedpaymentproviders.Youmusthaveacontractwiththem.Theyprovideyouwiththecredentialsneces-sary.
Authorize.NetSettings(youmustobtainthisinformationfromAuthorize.Net)
APILoginID Authorize.NetLoginIDorAPILoginID
TransactionKey TransactionkeyfromAuthorize.Net
CARDPRESENTCheckifyouhavea‘CardPresent’accountwithAuthorize.Net.BydefaultitissettoaCardNOTPresentaccount
ServerAddress
AddressoftheAuthorize.Netserver.https://secure.authorize.net/gateway/transact.dllForcardpresentaccounts:https://cardpresent.authorize.net/gateway/transact.dll
TestModeTransactionwillsendbesendtoAuthorize.Net intestmodeonly.Thecreditcardwillnotbeprocessed,butyouwillreceiveaproperresponse.(ThetrialapplicationisalwayssettoTestmode).
PayTraceSettings(youmustobtainthisinformationfromPayTrace)
UserName PayTraceUserName
PasswordPayTracePassword(PleaserememberyoumustchangeyourPay-Tracepasswordevery60days)
ServerAddress
AddressofthePayTraceserver.https://paytrace.com/api/default.pay
TestModeTransactionwillsendbesendtoPayTrace intestmode,usingthedemoaccount.Thecreditcardwillnotbeprocessed,butyouwillreceiveaproperresponse.
PPIPaymover(YoumustobtainthisinformationfromPaymentProcessingInc.)
AccountToken AccountTokengeneratedfromPaymentProcessing.
RETAIL
Check this ifyouhaveaRetail (industry type)account.OtherwiseDIRECT MARKETING is assumed. In case you use a card reader,thosetransactionsareautomaticallyassignedtotheindustrytypeRETAIL.
16 QMerchantManual
August27,2019
Hardware
CardReader
Use a magnetic stripe reader. Select the type of your magneticstripereader.QMerchantsupportsUSBHIDorUSBkeyboardemu-lationinterfacescardreaders.Amongthesupportedtypesare:MagTekMagMini21040101ornewerUICMSR213Encrypteddevices:(PPIgateway)MagTekMagneSafecardreaderMagTekIPadPinPad
ReceiptPrinterSelect the receiptprinter youuse. The selectionof ‘None’meansthatthereisnoprinterused.
AutoPrintIfchecked,automaticallyprintthereceiptafterasuccessfultrans-action.
PrintPreview Checkthisbox,toreviewthereceiptbeforeprinting.
PrintCopies Selectthenumberofcopies.
QuickBooks Settings (There are no specific transaction orpaymenttypesforQuickBooksPointofSale)
TransactionTypes(notavailablewithPOS)
Choose theQuickBooks transaction types forpaymentprocessing(checkall thatapply).Currentlywesupport thefollowingtransac-tion types from QuickBooks: ‘Sales Receipt’, ‘Receive Payment’,‘CreditMemo’, ‘Invoice’and‘SalesOrder’.Werecommendcheck-ingthefirstthreetransactiontypes.ForuseofRecurringBillingyoumustcheckInvoice.Default settings are: ‘Sales Receipt’, ‘Receive Payment’, ‘CreditMemo’.
Paymenttypes
Whichtypesofpaymentwillbehandledbyyourpaymentproces-sor (check all that applies)? These payment types are defined inQuickBooks in the Payment Method List. Usually you check alltypesofCreditCardPayments.
PreferencesAutomaticallycon-necttoQuickBooks
CheckifyouwillautomaticallylogontoQuickBooks.
QuickModeWhenchecked,aminimalpaymentwindowisshownfortheusualday-to-daytransactions.
UseShortCuts Enableuseofkeyboardshortcuts.
autoClosePaymentDefaultfalse.Ifsettotruethepaymentdialogisclosedautomaticallyafterprint-
17 QMerchantManual
August27,2019
ingoriftheprinterselectioninthesettingsissetto‘None’afterasuccessfulpaymenttransaction.
showSelectDialog
AlwaysshowtheSelectTransactionDialog.Default:true.IfsettofalsetheSelectTransactionDialogisshownonlywhen:
1. Notransactionsarefound.2. Morethanonetransactionisfound.
autoCloseSelectDialog
Default:false.Ifsettotrue,theSelectTransactiondialogisclosedautomaticallyiftherewasonlyonetransactionshown.
SendEmailReceipt
Send an email receipt to the customer via the selected paymentgateway.Currentlysupportedgatewaysare:
authorize.net(Overridesthemerchantaccountsettings)PayTrace
Pleaseentertheappropriatedataanddonotforgettopress‘Save’tostoreyoursettings.
18 QMerchantManual
August27,2019
KEYBOARDSHORTCUTSKeyboardshortssimplify theuseofsomeof theQMerchantdialog.Fivedifferentshortcutsare implemented for thefollowingdialogsandareactivewhenyouareconnectedtoQuickBooks.Theshortcutscangetmodifiedviathecustomsettingsdialog.Tousetheshortcuts,pleaseenableitinthesettingsdialog.
GLOBALThereisaglobalshortcutAlt–Gthatdirectlyopensthepaymentdialogfromanyapplication.Whenyoui.e.havesavedatransactioninQuickBooks,bypressingAlt-Gthepaymentwindowcomes.ThereisnoneedtobringQMerchanttothefront.MAINWINDOWAlt–G Getthepayment.Openeitherthepaymentdialogortheselecttransactiondialog.
SELECTIONOFTRANSACTIONSWINDOWAlt–P Processtheselectedtransaction.Openthepaymentwindow.Alt–C Closethewindow.
PAYMENTWINDOW(SMALLANDLARGEWINDOW)Alt–S SubmitthetransactionAlt–R PrinttheReceiptAlt–C Closethewindow.
19 QMerchantManual
August27,2019
20 QMerchantManual
August27,2019
MULTIPLEMERCHANTACCOUNTSYoucansimultaneouslyusemultiplemerchantaccounts.Theadministrationisdoneasfollows:
Pleaseenablethemultiplemerchantaccountsfeaturefromthespecialmenu.
EnterallnecessaryinformationinthePaymentGatewayInformationbox.
ThenenterintheMultipleMerchantAccountstextfieldanameforthisaccountandpress‘Add’.Thiswillcreatethismerchantaccount.
With‘Del’youdeletetheselectedaccountandwith‘Chg’youwillchangetheinformationfortheselectedaccount.
Ifyouneveraddedanaccount,theinformationasshowninthePaymentProviderGatewaywillbeused.Ifyouaddedonlyoneaccount,thatonewillbeusedautomatically.
Ifyoudefinedmorethanonemerchantaccount,youhavetoselectthemerchantaccounttouseatthedashboard.
Themerchantaccountselectionisvisibleonlyifyouhavedefinedalistofmerchantaccounts.
21 QMerchantManual
August27,2019
USEQMERCHANTASVIRTUALTERMINALWITHOUTQUICKBOOKSFromToolsmenuchoose‘VirtualTerminal’.Thefollowingdialogappears:
EnterthenecessaryinformationandpressSubmittoprocessthecreditcard.DependingontheversionofQMerchant,youcanprocesse-checkswithAuthorize.Netalso.Toswitchbetweencreditcardande-check,makeyourselectionofthepaymenttypeatthebottomofthedialogmentionedabove.Thee-checkpaymentdialogisasfollows:
22 QMerchantManual
August27,2019
Withthevirtualterminalyoucanalsoprocessothertransactiontypes.ThosearelistedatthebottomofthepaymentscreenundTX-Type.Mostcommontypesare
VOID Voidaprevious–notyetsettledtransaction.
REFUND Refundaprevioussettledtransaction
Pleaseenter intheparametersfield(bottomleft)thetransactionandtheauthorizationcodeseparatedbyaslash i.e.0006780/12345.Thenentertherefund/voidamount,creditcardnumberandexpirationdataandpresssubmit.
Ifyoudonotknowtransactionidorauthorizationcode,bothareincludedinthetransactionreportorthetransactionlog,accessiblefromtheQMerchantmenus.
23 QMerchantManual
August27,2019
USEQMERCHANTWITHQUICKBOOKSPRO,PREMIERE,ENTERPRISEAlwaysstartQuickBooksfirst,becauseQMerchantistriggeredautomaticallybyQuickBooks.
AfteraconnectiontoQuickBookswasestablished,theDashboardlookslikethis:
ThereareseveraltransactiontypessupportedbyQMerchant,whichareusedforfurthertransactionprocessing:
• SalesReceipt,• ReceivePayment,• CreditMemo• Invoices(automaticallycreatesareceivepaymenttransactionorusedforrecurringbilling)• SalesOrder(automaticallycreatesareceivepaymenttransactionifitisaCAPTUREtransaction)
Basedonexample screenshots fromQuickBookswewilloutline the typicalpaymentprocedure.Thisprocess remainsthesamewithotherQuickBooksversion,butthescreensmaylookdifferent.
Pressthegreen‘GetPayment’buttontocaptureapaymentfromQuickBooks.Hint:IfyouhavestoredcreditcardnumbersinQuickBooksandyouwouldliketousetheminQMerchant,pleaseopenthepaymentinformationofthecustomerinQuickBooksandcopyandpastethecreditcardnumberintotheaccountno.field.Ifthatfieldisusedforotherpurposes,pleasefollowtheinstructionsintheQMerchantTroubleshootsection(#10)
24 QMerchantManual
August27,2019
WORKINGWITHSALESRECEIPTS(TheoutlineoftheQuickBooksdialogsmayvaryandbedifferentdependingontheQuickBooksversionyouuse).
CreateasalesreceiptinQuickBooks.Inordertoprocessthepaymentandchargeacreditcard,itisimportantthatyouselectthecorrectPaymentMethod.Thismustbeoneofthepaymentmethodsyouacceptedinthesettingsdialog.Af-tercompletingthesalesreceipt,press‘Save&Close’or’Save&New’.Makesure,thatthethecheckbox‘’Process…paymentwhensaving’abovethe‘Save’buttonsinNOTchecked.OtherwiseyouwilluseIntuitforpaymentprocessing.
Nowpressthegreen‘GetPayment’buttoninQMerchant.TheinformationofthesalesreceiptistransmittedtoQMer-chantandthefollowingdialogpopsup.Mostfieldscontaininformationofthesalesreceipt.Pleasecompletethemissingfields(Thoseinyellowaremosttimerequired)andpresssubmit.Thiswillsendtheinformationtoyourpaymentproces-sorforfurtherprocessing.
25 QMerchantManual
August27,2019
Ifyoudidn’taddsomerequiredinformation,youwillseethosefieldsflaggedredandfurtherprocessingissuspendeduntilyouenterthe information.Asaresult,thepaymentprocessorrespondseitherwithasuccessorafailure. Inanycaseyouwillgetanappropriatemessage.Incaseofasuccesstheresultwillappearas:
26 QMerchantManual
August27,2019
Theresultingauthorizationcodeand/orthetransactionidareshown.Wheneveryouaddedorchangedthecreditcardinformation,thisinformationcanbecomestoredinQuickBooks.Pleasepress‘UpdateQuickBooks’todoso.Inanycase,theauthorizationcodeandthetransactionidarerecordedinQuickBooks.
Incaseofafailure,youcandirectlyreturntothesalesreceiptinQuickBooksanddothenecessarychangesthere.Haveinmind;thetransactionisrecordedinQuickBooks,eveniftheprocessingwithyourpaymentproviderfails.So,youareresponsibletotakecorrectiveactions.
Asmentionedabove,theauthorizationcode,thetransactionid,theamountchargesandthelastfourdigitsofthecreditcardarerecordedinQuickBooks.Tomakethosevisible,youmustchangeyoursalesreceipttemplate. Inthesalesre-ceiptpress‘CustomizeTemplate’andselectyourtemplatefromthedialog.
‘Edit’willleadyoutothefollowingscreen:
27 QMerchantManual
August27,2019
UnderfieldsisanadditionalentryQ_Authorization.
TherearealsosomefieldslabeledQ_RB_.Thoseareforusewithrecurringbilling.
PleasecheckthefieldQ_Authorizationandaddsometitlelike‘TXID’toit.Andpress‘OK’tosaveyourchanges.TheTXIDwillappearinthesalesreceiptasshownbelow.
28 QMerchantManual
August27,2019
USEOFCHECKSAnalternativetotheuseofcreditcardsistheelectroniccheckfeature.(Pleasenotethatthisisnotsupportedbyallpaymentgateways)
Just select inQuickBooks as paymentmethod ‘Check’. InQMerchant the echeck payment informationwill come up.Mostvaluesarepreset.Youhavetoenterthebankaccountnumberandthebankroutingnumber.AsyoucanseeatthebottomofthepaymentwindowaspaymenttypeECHECKisselected.
There isalsoaway toautomate theentryof thebanking information. InQuickBooksyoucandefinesomeadditionalfieldsthatholdthisdataforeachcustomer.Pleasenamethefieldsasfollow:
BankName: NameofthebankBankAccount: CustomeraccountnumberBankRouting: Routingofthebank(ABA)
IncaseyouworkwithinvoicesinQuickBooks,thenyoutomanuallyselectECHECKaspaymenttypeintheQMerchantpaymentscreen.
29 QMerchantManual
August27,2019
WORKINGWITHINVOICES/RECEIVEPAYMENTS(TheoutlineoftheQuickBooksdialogsmayvaryandbedifferentdependingontheQuickBooksversionyouuse).
WhenaninvoiceisrecordedinQuickBooks,thereisnotadirectpaymentinvolved.PaymentwillusuallybedonebyaReceivePaymenttransaction.
MakesurethatyouselecttheappropriatePaymentMethodandthen‘Save&Close’or‘Save&New’.Makesure,thatthethe checkbox ‘’Process…paymentwhen saving’ above the invoice list isNOTchecked.Otherwiseyouwill use Intuit forpaymentprocessing.
Nowpressthegreen‘GetPayment’buttoninQMerchant.TheinformationofthepaymentistransmittedtoQMerchantandthesamedialogsasdescribedwiththesalesreceiptprocedureabovewillfollow.
When in the Settings under Transaction Types the option ‘Invoice’ is checked, invoices for payment can be selectedmanually.Fromthedashboardpressthegreenbutton‘WaitforPayment’.Thiswillshowalistofunpaidinvoicesaswellasofalltransactionsfromthelast2/15minutes.
Usuallyonlyunpaidinvoicesareretrieved.Inadditiontothisretrievedinvoicesarefilteredbythepaymentterms.I.e.whenapaymenttermCreditCardisspecified,onlyinvoiceswiththistermareretrieved.Allothersareignored.Byde-fault,thereisfilteringofinvoicesdisabled.Toenableit,pleasechangethe‘FilterInvoicesbyTerm’inthe‘CustomSet-tings’.Pleasereadmoreunder‘CustomSettings’.Fromtheinvoicesshown,highlighttheoneforthepaymentandpressOK.
30 QMerchantManual
August27,2019
Youcanpaytheinvoicesimilartothesalesreceiptexplainedearlieron.Afterasuccessfulpayment,QMerchantauto-maticallycreatesareceivepaymentinQuickBooks. Inordertoseethesuccessfulpaymentintheinvoice,youhavetocustomizetheinvoicetemplateasdescribedforthesalesreceipt.Theinvoicewillthenlooklikethescreenshotbelow.
31 QMerchantManual
August27,2019
WORKINGWITHSALESORDERSTheuseofsalesordersinconjunctionwithQMerchantissimilartothehandlingofinvoices.
FirstyoucreateinQuickBooksasalesorder.Dependingonyourmodeofoperationyoucannowselect inQMerchantthesalesorderandprocessitwiththepaymentprovider.
Usually you justdoanauthorization to validate the credit cardandamount.Wewill storea successful authorizationbacktoQuickBooks.Whenyoulatercreateaninvoiceforthesalesorderthenyoucancapturetheamount.Itisbasicallythesameaswithinvoices.QMerchantdisplaystheauthorizationcode/transactionidofaformerauthorizationtransac-tion.Afterasuccessfulcapture,areceivepaymenttransactionisautomaticallygeneratedinQuickBooks.
Ifyouhavechosentochargethecreditcardwiththesalesorder,thenareceivepaymenttransactioniscreatedandyourcustomerhasacredituntilyouapplyittoaninvoicelateron.
Anexample(forauthorize.net):
InQuickBookscustomizethetemplatesforsalesordersandinvoicesandmadevisibletheadditionalfieldQ_Authorizationtoseetheauthorizationcodeandtransactionid.
InQMerchantinthecustomsettingschangeDefaultTxtypetoAUTH_ONLYtoavoidincidentalcaptureofsalesorders.AlsointheQMerchantsettingsselectSalesOrderastransactiontype(SointherightupperlistatleastSalesOrderandInvoiceischecked).
NowcreateasalesorderinQuickBooksandcaptureitviatheQMerchantgetpaymentbutton.InthepaymentscreenatthebottomthetxtypeisselectedasAUTH_ONLY.SubmitandauthorizethecreditcardandstoretheauthorizationcodebacktoQuickBooks.
ThencreateinQuickBooksfromthesalesorderaninvoice.OpenitinQMerchantviathegetpaymentbutton.Atthepay-mentscreenattheleftbottomistheauthorizationcodeshownandastxtypeVOIDisselected(Unfortunatelythisisthede-fault).ChangeVOIDintoPRIOR_AUTH_CAPTUREandsubmit.Thiswillnotaskforanycreditcardinfoandthecardwillbecharged.
32 QMerchantManual
August27,2019
WORKINGWITHCREDITMEMO(TheoutlineoftheQuickBooksdialogsmayvaryandbedifferentdependingontheQuickBooksversionyouuse).
ACreditMemoisatransactionwhereyourefundthecustomer.Thiscanbedonebyrefundingacreditcard.ThestepsinQuickBooksareasfollows:
CreatetheCreditMemo.
Saveitandchoosehowtoprocessthecreditmemo.
Issuetherefund.MakesurethatyouselectthePaymentMethodasindicatedandpress‘OK’.TheprocessingwithAu-thorize.Netisthesameasdescribedearlieron.
Makesure,thatthethecheckbox‘’Process…paymentwhensaving’atthebottomisinNOTchecked.OtherwiseyouwilluseIntuitforpaymentprocessing.Thenpressthegreen‘GetPayment’buttoninQMerchantandproceedinQMerchant.
33 QMerchantManual
August27,2019
RECURRINGBILLINGRecurringBillingissupportedfortheQuickBooksdesktopversions(notPoint-of-Sale)andwithauthorize.netaspaymentprovider.Therearesomestepsnecessarytoenablerecurringpayment.1.Withauthorize.netyouneedacard-not-presentaccountwithrecurringbillingenabled.2.InQuickBooksmakesurethatyouhaveunderTermsanentry‘RecurringBilling’.Furthermorecheckthatyouhavethesameentryavailableaspaymentmethod.TheseentriesareautomaticallyaddedwhenyouinstallQMerchant.3.IntheQMerchantsettingsdialog,selectInvoiceasTransactiontype.
4.Youuserecurringbillingwithinvoices.Wehavetwodifferentscenarioshere.
a. Youhaveanunlimitedrecurringbilling.Pleasechooseasinvoiceamounttheregular(i.e.monthly)paymentrate.InQuickBooks,enteraninvoiceamountwiththeregularpaymentamountandselect‘RecurringBilling”asTerms.
b. Youhaveafixednumber(i.e.12)ofpayments.InQuickBooks,enteraninvoiceamountwiththeentireexpectedpaymentsandselect‘RecurringBilling”asTerms.
Theinvoicetemplatewilllooklikethefollowing:
Inthepictureaboveyoualsoseesomeadditionalfields,whicharefilledbytheQMerchantapplication.Theyhavethefollowingmeaning:Q_Authorization:authorizationcode,transactionid,subscriptionidwhateverisappropriate,amountchargedQ_RB_Info:Ratefortherecurringbillingofthisinvoice,Intervalinwhichthebillingoccursandmaximalnumberofbillings.Whenyousavetheinvoice,youcanretrievethattransactionanddisplayit–viathe‘GetPayment’buttoninthepaymentdialogofQMerchant.AtthebottomofthemerchantdialogRecurringBillingisselectedaswellasCreateSubscription.
34 QMerchantManual
August27,2019
AdditionallytheRecurringBillingDialogisvisible.
Thefieldshavethefollowingmeaning:
• Start: Date,whenthebillingstarts.Bydefaultitistoday’sdate.TheformatisYYYY-MM-DD• Every: Periodinwhichthebillingoccurs.I.e.1Month=Everymonth,10Days,everythendays• Times: NumberoftimesthebillingoccursorUnlimited.
Whenyouchangethenumberoftimes,theamountwillbeadjusted.Itiscalculatedasamountoftheinvoicesdividedbytimes.Exceptyouchoose‘Unlimited’.Thentheamountisnotadjusted.Ifthesefieldsarecorrectandyouenteredthecreditcardinformation,thesubsriptionissubmittedtothepaymentprovider.That’sall.Afterasucessfulcompletionthesubscriptionidisshown.WhenyougobacktotheinvoiceinQuickBooks,itwilllooklikethiswithallQ_fieldspopulated.
Ifyoueverhavetheneedtocancelasubsription,youmayeitherdothatatthepaymentprovidersmerchantwebsiteorasfollows:OpentheVirtualTerminal,selectaspaymenttype‘RecurringBilling’,Cancel_SubscrastxtypeandenterthesubsriptionidoftheinvoiceinthefieldSubs_ID.Thensubmit.Thesubscriptionwillbecancelled.
35 QMerchantManual
August27,2019
Whenyoureceivelateronapaymentbyyourpaymentprovider,youmustmanuallycreateareceivepaymentinQuickBooksoruseourQImportsoftwareproduct.Tomanuallycreatethereceivepayment,pleasedothefollowinginQuickBooks.Selectthecustomeranditsinvoiceandopenthereceivepaymentdialog.Pleaseselectaspaymenttype‘RecurringBilling’.ThatwaysitpreventsQMerchantfromopeningupthepaymentdialogagain.Thedialoglooksasshownbelow.
36 QMerchantManual
August27,2019
BATCHPROCESSING(‘UNATTENDEDMODE’)Incaseyouhaveauthorize.netaspaymentgateway(othersmaybeimplementedlateron)youcanprocessaseriesofpayments inunattendedmode.Bydefault, theunattendedmode isNOTenabled.Tomakeuseof it,pleaseopenthesettingsdialogandclickthemenu‘Special’.Makesurethat‘AllowBatchProcessing’ischecked.
Whennowthegreen‘GetPayment’buttonispressed,thelayoutofthetransactionselectiondialogischanged.
Thequery for transaction remainsunchanged.After thequery isdone,QMerchantanalyzes the transactiondataandverifiesifthetransactioncanbeprocessed.Thatverificationdependsonthetx-type(AUTH_CAPTURE,AUTH_ONLYetc.)thatisused.Validtransactionsaremarkedgreenandchecked.Invalidonesareinredandunchecked.
Foralltx-types:Thetransactionmusthaveacreditcardnumberandanexpirationdate.Theamountofthetransactionislargerthanzero.
AUTH_CAPTURE:Validifthetransactionwasneverchargedearlieron.AUTH_ONLY:Validifthetransactionwasneverchargedearlieron.Allothertx-types:Validifthetransactionhasatransactionid/authorizationcode.
Regardlessofthecolormarking,youcancheckthetransactionanditwillbeprocessed.Hoveringthemouseoverthefirstcolumnofthelistshowsthereasonwhyatransactionismarkedgreenorred.
Pleasereviewalltransactionandcheckallthosetransactionthatmustbeprocessed.Thesmall+and–buttonsselectallornone.Whenthereviewisdone,click‘Processcheckedtransactions’.Theunattendedmodestarts.SametimearedSTOPbuttonisdisplayedthatstopstheprocessing.Duringtheprocessingeachtransactionsismarkedifprocessedsuc-cessfulornot.Ifsuccessful,itisstrokedoutandmarkedgray.Ifthetransactionfailed,itismarkedred.Hoverthemouseoverthefirstcolumnofthefailedtransactiontoseethefailurereason.Everythingelseisidenticaltothesingletransac-tionprocessing.Don’tforgettoreviewthetransactionlogaftertheunattendedmodeisfinished.
Still,youcanprocessasingletransactionasusual.
Reminder:Whenyouliketore-processthetransactionforwhatreasonever(likevoidingall),pleasequeryagain,sincethelistedtransactiondoNOTreflectthepreviousprocessingstate.ThatstateisupdatedinQuickBooksonly.
37 QMerchantManual
August27,2019
BEHAVIOROFTHEGETPAYMENTBUTTONThe behavior of QMerchant after you click at the Get Payment button depends on the transaction types you havecheckedinthesettings.QMerchantsupportsfivedifferenttransactionstypes.
SalesReceiptCreditMemoReceivePaymentInvoiceSalesOrder
Thefirstthree(SalesReceipt,CreditMemo,ReceivePayment)directlycorrespondtotherespectiveQuickBookstransac-tions.Whenthesetransactiontypesarecheckedandyoucreateoneofthosetransactions,theGetPaymentbuttonwillqueryQuickBooksforallthosetransactionscreatedormodifiedwithinthelastfiveminutes.Theyaredisplayedinadia-logandcanbechosenforfurtherprocessing.TheInvoicetransactionismainlyused,ifyouworkwithrecurringbilling.Here,theGetPaymentbuttonretrievesinvoic-escreatedormodifiedwithinthe lastfiveminutesandwithRecurringPaymentaspaymenttermset.Whenyouthenprocessatransactionwithyourpaymentprovider,QMerchantautomaticallycreatesareceivepaymenttransaction inQuickBooks,sothattheinvoicesismarkedPAIDinQuickBooks.
Mostcommon,onlySalesReceipt,CreditMemo,ReceivePaymenttransactiontypesarechecked,becausethosearetheonlyQuickBookstransactionthatareinvolvedinsomekindofpayment.Ifyoumainlyworkwithinvoices,thepleaseun-checkReceivePayment.OtherwiseyouwillseetransactioncreatedbyQMerchantinthepaymentselectiondialog.
Thetransactionsinthelistaremarkedasfollows:
ClearText:Acreditcardtransactionnotyetprocessed.
StrokedText:Atransactionthatisprocessed.DoubleclickitonlyifyouneedtoVOIDorRefundthetransaction.
38 QMerchantManual
August27,2019
ClearTextwithgraybackground:Atransactionsubmittedintestmode.So,thecreditcardwasnevercharged.EitherreprocessthetransactionoutsideoftestmodeorremoveitinQuickBooks.
ItalicText:Atransactionwherewecannotdetermineexactlyifitwasprocessedornot.Pleasecheckthetrans-actionlog.ThismayhappenonlyforSplittransactionsinQuickBooksPoint-of-Sale.
Queryfortransactionsbydate.
QuickBookshastwodifferentdates.Oneisthetransactiondate,asshowninthedatefieldofthetransaction.Theotheroneisthetransactionmodificationdate.Inthequerydialog,wemixboth.Whenyoujustchangedorcreatedatransaction(withinthelast15mins)thatoneisshown.
Whenyouquery fora transaction,we look for themodificationdateof the transaction.WhenusingaQuick-Booksdesktopversion,youcanalsoquerybytransactiondate.Thosearethequeries inthe lowerpartofthedateselectionbox.
Queryfortransactionsbyreferencenumber.
YoucanalsoseektransactionsinQuickBooksbyreferencenumber.Pleaseselect‘EnterReferenceorCustomer’andenterthereferencenumberofthetransactioninthequeryfield,replacingthedateselectionsandclickque-ry.Thequeryisdoneasfollows:
QuickBooksDesktopversions:Queryforthetransactiontypesasspecifiedinthesettingsdialog. Ifthetransactiontypeallowspaymentmethods(i.e.salesreceipt),onlycreditcardpaymenttransactionsareretrieved.
QuickBooksPoint-of-Sale:Onlysaleswithacreditcardpaymentareretrieved.
Queryfortransactionsbycustomername.
YoucanquerytransactionsinQuickBooksbycustomername.Pleaseselect‘EnterReferenceorCustomer’andenterthecustomernameinthequeryfield,replacingthedateselectionsandclickquery.Thequeryisdoneasfollows:
QuickBooksDesktopversions:Queryforthetransactiontypesasspecifiedinthesettingsdialog. Ifthetransactiontypeallowspaymentmethods(i.e.salesreceipt),onlycreditcardpaymenttransactionsareretrieved.
QuickBooksPoint-of-Sale:notavailable.
39 QMerchantManual
August27,2019
USEQMERCHANTWITHQUICKBOOKS–POINTOFSALE(TheoutlineoftheQuickBooksdialogsmayvaryandbedifferentdependingontheQuickBooksversionyouuse).
SelectQuickBooks–PointofSalefromtheQMerchant-Dashboard.
Thefollowingdialogappears.
Itmaytakesometimeuntilthenextscreenwiththecompanydataselectioncomesup.
SelectyourPOSdatafile.Itmayhappenthatyouwillseethesetupdialogsasdescribedearlier.
AfterthattheQMerchant-Dashboardlookslikethis:
40 QMerchantManual
August27,2019
InordertomakeasalewithQuickBooks–PointofSaleyoustartwiththefollowingscreeninQuickBooks–PointofSaleandcreateasale:(ThefollowingscreenshotsmaydifferinvariousQuickBooksPOSversions)
Createasale.
Afteryoufinishedpressthe‘Credit’buttonforcreditcardpaymentandadialogwiththevariouscreditcardscomesup..
41 QMerchantManual
August27,2019
Chooseoneofthecreditcardtypesandreturntothepreviousscreen.
Press“SaveOnly”orSave&Print”.NowyouarefinishedwiththeQuickBookspartofthepayment.NavigatetotheQMerchantDashboardandpress“GetPayment”
42 QMerchantManual
August27,2019
ThesaleisrequestedfromQuickBooks–PointofSaleandpresentedasfollows:
Completetheyellowfieldseitherbyswipingacreditcardorbyenteringthemmanually.ThenPress‘Submit’totransferthedatatoyourpaymentprocessor.Aftercompletionyouseeamessageboxwiththeresult.DependingonyourQuickBooks–PointofSaleversion,QMerchantwilladdthetransactionidandtheauthorizationcodetothesalesreceiptinQuickBooksPOS.Youalsocanhardcopyareceiptwiththe‘Print’button.Haveinmind;thetransactionisrecordedinQuickBooks,eveniftheprocessingyourpaymentprocessorfails.So,youareresponsibletotakecorrectiveactions.
Ifyourcustomerisgoingtopaythebillwithseveralcreditcards,pleaseenterthosedifferentpaymentsinQuickBooksPoint-of-Sale.QMerchantwillautomaticallycreatethenecessarynumberoftransactionsforapprovalandprocessing.
43 QMerchantManual
August27,2019
VOIDS,CREDITSANDREFUNDSQuickBooksPointofSalehasfourdifferenttransactiontypes,whichwillresultinacreditcardtransaction:
SalesandDepositwillchargeacreditcardwhileReturnandRefundwill refundacreditcard.Normallywewilldetectthesetransactiontypesautomatically.WealsodetectifaSaleisinfactarefundbecauseofexchangeditemsor.Means,wheneverwedetectthatthetotalamountisnegative,wetreatthisasarefund.
Theexception to this is aVOID. If you like to voida transaction, then clickatpayment screen inQMerchant the link‘SwitchtoMANUAL’.Thenyouareabletomakechangesintheparameterfieldsatthebottomofthepaymentscreen.PleaseenterthetransactionidofthetransactiontovoidintheTX-IDfield.SelectVOIDasTX-Type.Thenenterthecreditcardinformationandpresssubmit.
ImportantRules:
Thesearetheguidelinesforissuingacreditfromauthorize.net.Theyaresimilarforotherpaymentproviders:
ThistransactionisalsoreferredtoasaRefundandindicatestothegatewaythatmoneyshouldflowfromthemerchanttothecustomer.Thegatewaywillacceptacreditorarefundrequestifthetransactionsubmittedmeetsthefollowingconditions:
• The transaction is submitted with the ID of the original transaction against which the credit is being issued(tx_id).
• Thegatewayhasarecordoftheoriginaltransaction.• Theoriginaltransactionhasbeensettled.Ifitisnotsettled(usuallythetransactionisasoftoday,pleaseusethe
VOIDfunction)• ThesumoftheamountsubmittedintheCredittransactionandallcreditssubmittedagainsttheoriginaltransac-
tionislessthantheoriginaltransactionamount.• Thefullorlastfourdigitsofthecreditcardnumbersubmittedwiththecredittransactionmatchthefullorlast
fourdigitsofthecreditcardnumberusedintheoriginaltransaction.• Thetransactionissubmittedwithin120daysofthesettlementdateandtimeoftheoriginaltransaction.
Incaseyousubscribed toauthorize.netECCExpandedCreditCapabilities, youcancreditanyamount toacredit cardoutsideoftherulesabove.ECCcanbeenabledattheauthorize.netmerchantwebsite.
44 QMerchantManual
August27,2019
QUICKMODEFordaytodaytransactionsi.e.saleorsalesreceiptyoucanchooseinthesettingstousethequickmodeinsteadofthefullpaymentview.Thewindowshowsasfollowsandallowsyoutoenter/swipethecreditcardinformationandsubmitthedatatothepaymentgatewayprovider..
Allbuttonshavethesamefunctionsasinthefullpaymentview.
Aclickatthesmallbuttonlabeled‘F’returnsyoudirectlytothefullpaymentview.
45 QMerchantManual
August27,2019
SERVERINSTALLATIONANDMANAGEMENTInstallQMerchantataWindowsserverofyourchoice.QMerchantisinstalledforAllUsers.
TheinstallationofQMerchantforaserverisidenticaltothedesktopinstallation.PleaseconfigureQMerchantcomplete-lyatyourfirstdesktopstation.TheservermanagementisavailableafterQMerchantisactivatedbyaserveractivationcode.Duringthisactivationthecurrentprofileandallsettingsarecopiedtoacommonplace,whereallusersofQMer-chantcanaccessthose.
Whatistheeffectofaserver?
ThenormalusercanonlychangetheQMerchantsettingsforsomeindividualparametersasprinterorswipereader.Allothersettingsaredisabled.OnlytheQMerchantadministratorcanchangethosesettingsandmakethemavailabletoall.
AfterServeractivation,fromtheSupportmenu,anewentry‘ServerManagement’isshown.WithservermanagementanormalusercancopythecommonQMerchantprofiletoitsindividualstation.Also,youcanlogonasAdministrator.Theloginispasswordprotected.ThepasswordisalwaystheQMerchantserialnumber,availablefromtheAboutdialog.
OnlytheQMerchantadministratorcanchangetheQMerchantsettingsaswellasthecommonprofile.Thesettingsaresavedautomatically.Ifyouwouldliketomakeyourindividualsettingsavailableforeverybody,usethesetprofilemenucommand.
QMerchantdeactivation.
OnlytheQMerchantadministratorcandeactivateQMerchant.Afterloginasadministrator,theLicenseManagementisvisible.
46 QMerchantManual
August27,2019
LEVELIIDATASome payment providers support Level II transaction data. Level II data are submitted automatically. The followingscreenshotshowsthepositionoftheLevelIIdata.
Thecalculationsareasfollows:
PO_NumiscopiedfromReference.TaxiscalculatedCustomerIDisgeneratedfromLastnameandFirstnameTaxExemptissetifthereisataxamountornot.Regardingdutyandfreight,theamounttransmittedis0.00.IfwedetecttheitemsDuty,FreightorShippingwewilltransmittherealamount.Allfieldsareeditable.Iftaxischanged,thesubtotalischanged.
47 QMerchantManual
August27,2019
LEVELIIIDATAWhenusingbusinessorgovernmentpurchasecard,atleastLevel2dataarerequiredasexplainedabove.InadditiontothatLevel3 isastepto lowerthetransactioncosts.Currently–uptoourknowledge–onlyafewpaymentgatewayshaveimplementedtheacceptanceofLevel3data.
QMerchant currently supports the transmissionof Level3data for thePayTrace gateway.Youcan specify theuseofLevel3inthesettingsdialog.
Bydefault,theLevel3modeisNOTenabled.Tomakeuseofit,pleaseopenthesettingsdialogandclickthemenu‘Spe-cial’.Makesurethat‘Level3’ischecked.
QMerchanttransmitsthefollowinginformationtothepaymentgateway:
AllLevel2fieldsplusShip-TocountryShip-TopostalcodeAdditionalTax=0.00AdditionalTaxrate=0.00Informationforallthelineitems:
ID,Description,Quantity,UnitofMeasureasEACH,Unitprice,Amount,Addl.Taxas0.00,Addl.Taxrateas0.00,Discountas0.00
48 QMerchantManual
August27,2019
CIM(AUTHORIZE.NETCUSTOMERINFORMATIONMANAGEMENT)WithQMerchantv5.1.0wesupporttheusageofauthorize.netcustomerprofiles(CIM)toprocesspayments.
CIMisnotenabledautomatically.Toenableit,pleaseselectfromtheInformationmenuSupport|CustomSettings.Ac-ceptthemessage.FromthefollowingdialogrevertCimEnabledfromfalsetotrue.Pressoktosavethedialog.
Whenyouopenapaymentscreen i.e.via theVirtualTerminalyouseeanewentryCIM in themenuof thepaymenttypes.
WhenyouselectCIM,thereisanewgroupoffieldbelowthecreditcardinformation.
49 QMerchantManual
August27,2019
Thefieldshavethefollowingmeaning:
ThefirsttextboxistheCustomerProfileID.TheseconddropdownlistcontainstheCustomerPaymentProfileIDs.BotharenecessaryinordertouseCIMforpayment.
WiththecheckboxyoucandefinetouseCIMortouse.i.e.acreditcardforpayment.
WiththeUpdateButtonyoucanchangethecreditcard information intheCIMpaymentprofile.Addeithercreatesanewcustomerprofileatauthorize.net(ifnotalreadydefined)oraddsanewpaymentprofilethere.ThebuttonwiththequestionmarkshowstheCIMprofileasgiveninthefirsttextbox.
Youcanhaveasmanyastendifferentpaymentprofiles.Ifthereismorethanoneprofileyouhavetoselectwhichonetouse.Inadditiontothepaymentprofilenumberweshowthelast4digitsofthecreditseparatedbyanasterisk.
MosttimesCIMisusedwiththeCIMprofile informationcapturedfromQuickBooks.Weexpectthat informationcon-tainedanadditionalfieldnamedQ_CIM,definedatthecustomerlevelinQuickBooks.TheinformationinthefieldistheProfileID.WhenQMerchantfindsthatinformationwewillautomaticallysuggestitforpayment.
IncasethatyoudonothaveaCIMProfile,usecanusetheAddbuttontocreateone.IfthecreationwassuccessfulwewillautomaticallytransferittoQuickBooksandstoreitintotheQ_CIMfieldforlaterusage.
IfyouhavetheneedtocreatealargeamountofCIMprofiles,werecommendtheusageofourothertoolslikeQImport.Pleasecontactourhelpdesk.
InQuickBooksPoint-of-Sale,pleasedefineacustomfieldas follows:FromthePreferencesmenuselectCompanyandthenfromthelistboxGeneralandMyFieldLabels.Nameoneofthe“CustomerCustomFields”Q_CIMandcheckUse.Leavethedialogwithsave.
Note:QMerchantcurrentlydoesnotallowtheuseofrecurringbillingwithCIM.
50 QMerchantManual
August27,2019
USEOFMAGNETICSTRIPEREADERSQMerchant supports several Magnetic Card Readers. Most commonly used is the Magtek USB Reader like MagTek21040101thatweusedfortesting.EveniftheyhaveanUSBconnector,theyoperateeitherasUSBHIDdeviceorasocalledkeyboardwedge.
Yousimplecantest,whichtypeofcardreaderyouhave.PleaseopentheWindowsnotepad.Placethecursorintothenotepadandthenswipeacard.Ifyouseethecarddatainthenotepadthenyouhaveakeyboardwedge.IntheQMer-chantsettings,pleaseselect‘Keyboard’.
OtherwiseyouhaveanUSBreader.Pleaseselecttheappropriatetype.
Useofkeyboardwedge:
Whenthepaymentscreenopens,thecursor isusuallyplaced inthecreditcardnumberfield.Nowyoucanswipethecardandtheinformationfromthecreditcardisdisplayinthevariousfields.Youcanrepeattheswipeasoftenasyouneed.PleasemakesurethatifpossibleyourkeyboardwedgesendaCRafterfinishingreading.Pleaseconsultthestripereader’smanual.
UseofUSBcardreader:
Whenthepaymentscreenopens,youcanswipethecardatanytime.Ifthecardisswipedsuccessfully,agreenlabelisshownabove thesubmitbutton.Wheneveryouneed toswipe thecarda second time (i.e. thecustomerchanged itsmind),thenclickthatgreenlabel.Thecolorofthelabelbecomesyellowandyoucanswipethecardagain.
51 QMerchantManual
August27,2019
QMERCHANTMENUENTRIESTools
Settings Opensthesettingsdialog
Backup/Restore Opensadialogtobackupand/orrestorethesettingsandthelogfiles.
VirtualTerminal OpentheVirtualTerminalfortransactionsoutsideofQuickBooks
GetTransactionfromQuickBooks Samefunctionasthe‘GetPayment’button.
PaymentGatewayVirtualTerminal OptionalmenutonavigatetoyourpaymentprovidersVirtualTerminal(availableforselect-edpaymentprovidersonly.Pleasecontactourhelpdesk.)
SetupWizard Re-Initializes all settings forQuickBooks and your payment provider. Currently this is sup-portedforauthorize.netonly.
Re-PrintReceipt Re-Printatransactionreceipt.
ExitQMerchant EndtheQMerchantprogramanddisconnectfromQuickBooks
Information
About OpenstheAboutdialog,whichdisplaytechnicalinformation.
Help OpensthisQMerchantGuide.
ViewSaleslog Displaythelistofsalesdone.
ViewApplicationlog Displaythetechnicalinformationlogfile.
ViewTransactionlog Displaythelistoftransactionsdone.
ViewSalesReceiptbyrefnumber QuickBooksPointofSaleonly.Retrievetransaction idandauthorizationcodeofa transac-tionreferencedbyareferencenumber.
TransactionReport Showsaformattedreportofthedailytransactions
SalesReport Showsaformattedreportofthedailysales
52 QMerchantManual
August27,2019
Support
CustomSettings Openthecustomsettingsdialog(onadviceoftheQMerchantsupportteamonly)
TestMSR Testamagneticstripereaderorcardreader.
ShowDataFolder Openthefolderlocation,whereQMerchantstoresitsdata.
ServerManagement (availableintheQMerchantServerversiononly)
LoginasAdmin LoginasadministratorforQMerchantserver
SetUserProfile SetprofileinformationforaQMerchantServeruser
GetUserProfile ReplaceprofileinformationforaQMerchantServeruser
License
PurchaseLicense PurchaseyouQMerchantlicense.
Activation AfterpurchaseyouwillreceiveanactivationcodeforQMerchant.Pleaseenterithere.
De-Activation Incaseyouaregoingtouseyouractivationcodeatadifferentcomputer,pleasedeactivateitherefirst.
ViewLicenseAgreement Readthesoftwarelicenseagreement.
53 QMerchantManual
August27,2019
THELOGFILEAlltransactionssendtoyourpaymentproviderarerecordedinadailylogfile.ThelogfilecanbeaccessedviatheDash-board.ItopensanInternetExplorerwiththefollowingcontent(similarforotherpaymentproviders):
ForPayTracethelogisasfollows:
54 QMerchantManual
August27,2019
TRANSACTIONTYPESANDOTHERCODESMostcommontransactionTypes
Whenworkingwithacreditcardtransactionprocessor,youcanspecifyseveraltransactiontypes:
AUTH_CAPTURE Thisisthemostcommontransactiontype.Itauthorizesthetransactionamountandcapturesthemoney
AUTH_ONLY Justauthorizetheamount.Itmustgetcaptureslateron.CAPTURE_ONLY Capturesapreviouslyauthorizedamount.(Needstheauth-codeortransactionid)VOID Cancelsanauthorization,voidsatransaction(Needstheauth-codeortransactionid)CREDIT Reimbursesthecreditcard(Forauthorize.Netonly)(Needstheauth-codeortransactionid)CREATE_SUBSCR Createasubscriptionforrecurringbilling.CANCEL_SUBSCR Cancelasubscriptionforrecurringbilling.
AVSCodes
A=Address(Street)matches,ZIPdoesnotB=AddressinformationnotprovidedforAVScheckE=AVSerrorG=Non-U.S.CardIssuingBankN=NoMatchonAddress(Street)orZIPP=AVSnotapplicableforthistransactionR=Retry–SystemunavailableortimedoutS=ServicenotsupportedbyissuerU=AddressinformationisunavailableW=9digitZIPmatches,Address(Street)doesnotX=Address(Street)and9digitZIPmatchY=Address(Street)and5digitZIPmatchZ=5digitZIPmatches,Address(Street)doesnot
CardCodeverificationCodes
M=MatchN=NoMatchP=NotProcessedS=shouldhavebeenpresentU=Issuerunabletoprocessrequest
55 QMerchantManual
August27,2019
PRINTRECEIPT
CHANGETHEPRINTRECEIPTThetemplateforprintreceiptislocatedintheapplicationdatafolderandisnamedprintreceipt.xsl.TheapplicationdatafoldercangetaccessedviatheAboutDialogwithaclickatthelink‘OpenApplicationDataFolder’
Openthefileprintreceipt.xslwiththenotepadeditorandeditthehighlightedlinesasfollows:
Pleaseplaceyourcompanyheaderinformationattheplacemarkedyellow.Youalsocanaddafooterlineattheplacemarkedyellow.Ifyouhavetohaveanewline,pleaseusethefollowingcharactersequence:
.Donotforgettosavethefile.
<xsl:stylesheetversion="1.0"xmlns:xsl="http://www.w3.org/1999/XSL/Transform"><xsl:outputmethod="text"indent="no"omit-xml-declaration="yes"/><xsl:paramname="topMargin">20</xsl:param><xsl:paramname="leftMargin">10</xsl:param><xsl:paramname="firstTab">60</xsl:param><xsl:paramname="barCode">true</xsl:param><xsl:paramname="barFont">Free3of9Extended</xsl:param><xsl:paramname="barSize">48</xsl:param><xsl:paramname="barReference">//Reference</xsl:param><xsl:paramname="logoName">logo.jpg</xsl:param><xsl:templatematch="/|@*|node()"><xsl:comment>Placeyourcompanyheaderbelow</xsl:comment><xsl:comment><![CDATA[<LOGO>]]></xsl:comment><xsl:text></xsl:text><xsl:comment>YourCompanyheaderinthetextabove</xsl:comment><xsl:text>
Receipt
</xsl:text><xsl:value-ofselect="Receipt/PaymentType"/><xsl:text>
Reference:</xsl:text><xsl:value-ofselect="Receipt/Reference"/><xsl:textxml:space="preserve"></xsl:text><xsl:value-ofselect="Receipt/Date"/><xsl:text>
</xsl:text><xsl:value-ofselect="Receipt/Description"/><xsl:text>
</xsl:text><xsl:value-ofselect="Receipt/NameOnCard"/><xsl:text>
</xsl:text><xsl:value-ofselect="Receipt/CardType"/><xsl:textxml:space="preserve">****</xsl:text>
56 QMerchantManual
August27,2019
<xsl:value-ofselect="substring(Receipt/CreditCard,string-length(Receipt/CreditCard)-3)"/><xsl:text>
</xsl:text><xsl:for-eachselect="Receipt/Items/SingleItem"><xsl:value-ofselect="ItemID"/><xsl:text>	</xsl:text><xsl:value-ofselect="Description"/><xsl:text>	</xsl:text><xsl:value-ofselect="Price"/><xsl:text>	</xsl:text><xsl:value-ofselect="Quantity"/><xsl:text>	</xsl:text><xsl:value-ofselect="Total"/><xsl:text></xsl:text></xsl:for-each><xsl:text></xsl:text><xsl:textxml:space="preserve">Subtotal:	</xsl:text><xsl:value-ofselect="Receipt/Subtotal"/><xsl:textxml:space="preserve">
Tax:	</xsl:text><xsl:value-ofselect="Receipt/Tax"/><xsl:textxml:space="preserve">
Total:	</xsl:text><xsl:value-ofselect="Receipt/Total"/><xsl:text>

</xsl:text><xsl:iftest="Receipt/PaymentType='RECURRINGBILLING'"><xsl:text>RecurringBilling
</xsl:text><xsl:textxml:space="preserve">Rate:	</xsl:text><xsl:value-ofselect="Receipt/ARBRate"/><xsl:text>
</xsl:text><xsl:textxml:space="preserve">Start:	</xsl:text><xsl:value-ofselect="Receipt/ARBStart"/><xsl:text>
</xsl:text><xsl:textxml:space="preserve">Interval:	</xsl:text><xsl:value-ofselect="Receipt/ARBIntv"/><xsl:text>
</xsl:text><xsl:textxml:space="preserve">Times:	</xsl:text><xsl:value-ofselect="Receipt/ARBMaxOccurrence"/><xsl:text>
</xsl:text></xsl:if><xsl:text>
</xsl:text><xsl:value-ofselect="Receipt/Processor"/><xsl:text>
</xsl:text><xsl:value-ofselect="Receipt/TxType"/><xsl:textxml:space="preserve">
AuthCode:	</xsl:text><xsl:value-ofselect="Receipt/Authorization"/><xsl:textxml:space="preserve">
Transaction-ID:	</xsl:text><xsl:value-ofselect="Receipt/TransactionID"/><xsl:text>
</xsl:text><xsl:text>



................................................</xsl:text><xsl:text>
Signature

</xsl:text><xsl:comment><![CDATA[<BARCODE>]]></xsl:comment><xsl:comment>Placeyourcompanyfooterbelow</xsl:comment><xsl:text></xsl:text><xsl:comment>YourCompanyfooterinthetextabove</xsl:comment><xsl:comment><![CDATA[<PAGEBREAK>]]></xsl:comment><xsl:comment>Possiblyanotherpage</xsl:comment></xsl:template></xsl:stylesheet>
57 QMerchantManual
August27,2019
BARCODEPRINTINGBydefaultbarcodeprintingisswitchedoff.Toenableit,pleasedothefollowing:
1. ChangethebarCodeparameterintheprintreceipt.xslfileto“true”(Itismarkedblueinthelistingabove)2. Printingisdonebyaspecialfont.Itisnamed“Free3of9extended”.ThisfontisdeliveredwitheachQMerchant
distribution,butnotinstalledautomatically.Pleasegotothesamelocationwheretheprintreceipt.xslfileisanddouble-clickthefileFRE3OF9X.tff.Thiswillinstallthefont.
3. Bydefaultthereferencenumberofthetransactionisbarcoded.4. Tochangethebarcodesize,theinformationtobarcodeorthefonttype,pleasechangetheappropriateparame-
tersintheprintreceipt.xslfileorcontactaddQinsupport.5. Don’tforgettosavetheprintreceipt.xslfile.
RECEIPTFORMATTINGPARAMETERSANDCOMMANDSParameters:
topMargin Positionfromthetopofthepageinpoints(Default:20)leftMargin Positionfromtheleftinpoints(Default:10)firstTab Positionofthefirsttabinpoits(Default:60)barCode Printabarcode(Default:false)barSize Heightofthebarcodeinpoints(Default:48)barFont Fontusedforbarcodeprinting(Default:3FreeOf9Extended)barReference Contentofthebarcode(Default:Referencenumber)logoName Nameofthelogofile(Default:logo.jpg)
Commands:
<![CDATA[<BARCODE>]]> Placeholderforthebarcodeposition<![CDATA[<PAGEBREAK>]]> Continueprintingatanewpage<![CDATA[<LOGO>]]> Placeholderforlogoatthetopofthereceipt
SpecialCharacters:

 Newline(Linefeedandcarriagereturn)	 Tabcharacter
58 QMerchantManual
August27,2019
RE-PRINTARECEIPT.Choosethisfunction,ifyouneedanoldprintreceiptorincaseyouforgottoprintthecurrentreceipt.
Selectthedateofthetransaction.Thenenteroneofthefollowing:
• transactionid• authorizationcode• amountofthetransactionor• reference
Ifyoudonotknowoneofthosevalues,pleaseopenfromtheReportsmenuthesalesreportandcheckoutthetransac-tionid.Afterwardsyouwillseetheprintdialogand/oryoucanprintthereceipt.
59 QMerchantManual
August27,2019
CUSTOMSETTINGSThesesettingscontrolinsomeaspectshowQMerchantbehaves.Pleasechangethosesettingsonadvicebyoursupportteamonly,sincewrongsettingsseriouslyinfluencethewayQMerchantoperates.
Thedescriptionofthesettingsisasfollows:
Name Default Comment
AcceptPendingTransactions False WhensettotruependingtransactionsfromQuickBooksarealsoselectedforpayment.Bydefaultthoseareignored.
allowShortCuts False Allowsshortcutsinthepaymentwindow.Implementedshortcutsare:Alt-C=CloseWindowAlt-S=SubmitTransactionAlt-P=PrintReceipt
AlternateTxType Valid transaction type as alternate to the defaults. I.e.AUTH_ONLYinsteadofAUTH_CAPTURE.
AlwaysShowTxDialog True Alwaysshowaselecttransactiondialog.IfsettoFalse,thedialogissuppressedifonlyonetransactionisavailable.
AppDirectory Locationofapplicationdatafolder.
ARForPayment AR-Account name in QuickBooks (without the numbers) whereto place the received payment. By default it is placed into ‘Ac-countsReceivable’.
AutoApplyRPayment True Applies an automatic receive payment automatically by Quick-Books if the payment cannot be applied to the original invoice
60 QMerchantManual
August27,2019
transaction.
autoClosePayment False Automaticallyclosethepaymentdialogafterasuccessfultrans-action.
autoCloseTxDialog False Automaticallyclosethetransactionselectiondialog.
AutoPrint Automatically (Auto) print a receipt after a successful transac-tion.
CCExpDateFieldName CCExpDate Name of custom field that contains the credit card expirationdate
ccFormLocation 150,150 Screenlocationofthepaymentform
CCNumberFieldName CCNumber Nameofcustomfieldthatcontainsthecreditcardnumber.De-faultistheuseoftheaccountnumberofthecustomerpaymentinfo.
CheckFields True Checkthefieldforplausibilitybeforesubmittingatransactions
CIMEnabled False Ifsettotrueusesauthorize.netCIMforpayments.
CIMValidate none ValidationcodeforCIMtransactions
ColorTransactions True Showgreencoloriftransactionhasvalidcreditcardcredentials.
CountryList Comma separated list of countries placed before the commonlist.WerecommendthatyoualsoaddthecountryISOcode.Thesyntaxisafollows:USA;US,Canada;CA…
Firstcomesthenameyouliketoseeinthelistandthenseparat-edbysemicolonthetwocharacterISOcode.
CustBankAccount BankAccount NameoftheQuickBooksadditional fieldthatholdsthecustom-er’sbankaccountnumber.
CustBankName BankName NameoftheQuickBooksadditional fieldthatholdsthecustom-er’sbankname.
CustBankRouting BankRouting NameoftheQuickBooksadditional fieldthatholdsthecustom-er’sbankroutingnumber(ABA).
Debug False RecordallmessagestoandfromQuickBooks.
DefaultTxType AUTH_CAPTURE DefaultTransactiontype.UsuallyAUTH_CAPTURE.
DepositPaymentTo Deposit-Account name in QuickBooks (without the numbers)wheretoplacethereceivedpayment.Bydefaultitisplacedinto‘UndepositedFunds’.
61 QMerchantManual
August27,2019
DutyItemNames Duty ListofthenamesoftheQuickBooksitemsspecifyingduties.Thisisusedtospecifyashipmentamounttothepaymentgateway.
EditMode False Makeitemlistandamountseditable.
EnableBatch False Allows the simultaneous processing of multiple credit cardcharges
forceCCV False Forcetheentryofthecard’sCCVcode
ForceQBXMLVersion False Internaluseonly.
forceZip False ForcetheentryofaZIPcodeinthecustomerbillingarea
getCCfromParent False Get credit card information from the parent customer in casethereisnoinformationatthejob.
hideWinControlBox False HideWindowsControlboxes
IgnoreQBDSubtotal False Ignores in the item lines an item that contains ‘Subtotal’ in itsname.
ignoreReversed True Point-of-Saleonly.Don’tshowreveredtransactions.
InstalledVersion n/a Internaluseonly.
InvoiceFilterbyTerm Placethenameofthetermincaseyou liketofilter invoicesbyterm. This field is case sensitive. If youwant to switch off thisfilter,removereplacetheentrywithblanks.
Itemized False Iftruesendsitemizedtransactionstoauthorize.net.ForPayTraceitsendsLevel3informationtothepaymentgateway.
L3 False EnableLevel3transactionsforPayTraceandSecureNet
L3SourceZip ZipcodeofthemerchantforLevel3processing
LicenseRead Internaluseonly.
mainFormLocation 100,100 Screenlocationofthemainform.
MaskCCNumber True Maskscreditcardandbankaccountnumbersinreports.
MaxReturnedQueryResults 50 NumberofreturnedresultsforaqueryagainstQB.
ModifiedMinutesBack1 2 Numberofminutessearchedbackbythe‘GetPayment’button
ModifiedMinutesBack2 15 Alternate number of minutes searched back by the ‘Get Pay-ment’button
MSR NameofMSRtype(Keyboard,COM,USB)
62 QMerchantManual
August27,2019
MsrASynch True UseMagneticCardReadertoasynchronousmode.
MSRClose True
MsrOverlap False
MsrTimeout 30000 TimeoutforsynchronousMSRoperations
multipleMerchantAccounts False Supportofmultiplemerchantaccounts.
PrintCopies 1 Numberofprintreceiptcopies
Printer Nameofreceiptprinter
PrintPreview False Showpreviewbeforeprinting
QBDLaunchMode 1 QuickBooksconnectionmode.
QBPOSConnection SetsthePoint-of-Saleservertoaspecificdatabase.Themustbeasshowninthefollowingsample:
ComputerName=QUAD;CompanyData=TestPOS;Version=10
QBVersion n/a Internaluseonly.
QBXMLVersion “2.0” MinimumQuickBooksversion
QuickMode False Showabbreviatedpaymentscreen.
RefundForLinkedTransactionsOnly
True Querycreditmemosandrefundforpreviouscreditcardtransac-tionsonly.
RemoveItemAfterProcess True Removesasuccessfullyprocessedtransaction fromthe transac-tionselectiondialog.
sc_Close C Closeawindow(Alt-C)
sc_GetPayment G Openthepaymentdialog(Alt-G)
sc_GlobalGetPayment G Globalshortcuttoopenthepaymentscreen.(Alt-G)
sc_Process P Openthepaymentscreenfortheselectedtransaction(Alt-P)
sc_ReceiptPrint R Printthereceipt(Alt-R)
sc_SubmitTx S Submitthetransaction(Alt-S)
selSrFormLocation 120,120 Screenlocationtotransactionselectionform
SendEmailReceipt False If supported by the payment gateway, automatically send anemail receipt. Currently only authorize.net and PayTrace aresupported.
63 QMerchantManual
August27,2019
SetPaymentMethodForRP False SetapaymentmethodfornewreceivepaymentsinQuickBooks.Otherwiseapaymentmethodisignored.
ShipItemNames Shipping,Freight Listof thenamesof theQuickBooks items specifying shipment.Thisisusedtospecifyashipmentamounttothepaymentgate-way.
shouldUpdate True Internaluseonly
ShowBackToQBBtn False If set to true the ‘Back toQuickBooks’ button is always shown.OtherwiseQMerchantcontrolstheappearanceofthisbutton
ShowInTaskbar True Set toFalse ifQMerchantshall showup in the icontrayonly, ifminimized.
ShowProcessedTxAlso True Iftrue,showsallprocessedtransactionsalso.
TLS12 True EnableTLS12Security
TxConfirmationMsg False ConfirmationMessagebeforeatransactionisprocessed.
Trace False Records completemessages between QMerchant and the pay-mentprovider.
UpdateAppliedToTxn False Propagate the transaction id and authorization code to linkedtransactionsinQB.
UseSaveMemory True ReleaseUnusedMemory.
UseTrack 0 Magnetictracktouse.(0=automaticallyselected)
UseTxInfo False UsesinadditiontoPOSflagthetxinfo.db3databasetofilterpro-cessedtransactions.POSonly.
vPosUrl Theurlforthepaymentgatewayweb-basedvirtualterminal(.i.e.for authorize.net https://anet.vpos.authorize.net/). Please con-sultyourpaymentgatewayprovider.
64 QMerchantManual
August27,2019
REPORTSTransactionReport
SalesReport
65 QMerchantManual
August27,2019
ACTIVATIONWhenyoufirststartQMerchant,itworksautomaticallyinTestMode.Thisallowsyoutoplayaroundwiththesoftwareand become familiar. The only limitation in contrast to the activated product is that themaximum amount you canchargeislimitedto5.00.
ToswitchtoproductionmodeyouhavetopurchaseQMerchantfromhttp://www.addqin.com/QMerchant.Afterpur-chaseyouwillreceiveanactivationcode.Thiscodeisdisplayedafterpurchaseandisalsosendtoyouremailaddress.
Toactivate,pleaseselectinQMerchantfromthemenubarInformation,LicenseandthenActivation.
In thedialog, copy andpaste the activation code andpress ok.After the activationprocess finishedQMerchant re-starts.Thenopenthesettingsdialogandun-checkthetestmodecheckbox.Leavethesettingsdialogwithsave.
IfyouwouldliketouseQMerchantatadifferentcomputer,youcande-activatetheactivationcodeandactivateitattheothercomputeragain.Youalsocanresetyouractivationatthehelpdeskathttp://www.addqin.com/QMerchant
66 QMerchantManual
August27,2019
PAYMENTGATEWAYSQMerchanthasimplementedthefollowingpaymentgatewayfunctionality.Iffunctionalityismissingornotimplement-eddoesnotmeanthatthepaymentgatewaysdoesnotofferit.
Function
Authorize.net
PPIPaymover
PayTraceAuth_CaptureThisisthetypicalsale.Authorizethecardandcapturetheamount
! ! !CaptureOnlyCapturetheamountafteraspriorauthorization ! ! !AuthOnlyAuthorizetheamountandcapturelater ! ! !VoidVoidatransactionthatisnotsettled ! ! !CreditIssuearefund ! ! !Force_AuthForceanauthorization " ! "Force_SaleForceanauthorizationandacapture " ! "PriorAuthCaptureCapturetheamountafteraspriorauthorization ! " "PinDebitAuthorizeandcapturetheamountusingaPinbasedDebitCard
" ! "QueryQuerythestateofatransaction " ! "eCheckProcesscheckselectronically ! ! !RecurringBillingUsethepaymentgatewaysrecurringbilling ! " "CustomerInformationManagementUsethepaymentgatewayscustomermanagementsystem ! " "Level2transactionsSubmittransactionsaLevel2transactionsforbetterrates ! ! !Level3transactionsSubmittransactionsaLevel3transactionsforbetterrates " " !
67 QMerchantManual
August27,2019
AUTHORIZE.NETAPILOGINIDANDTRANSACTIONKEY
Pleaselog-intoyourmerchantaccountadministrationattheauthorize.netwebsite.ThennavigatetoSettingsandthenGeneralSecuritySettings.Choose‘APILoginIDandTransactionKey’.
YourAPILoginIDandTransactionKeyareuniquepiecesofinformationspecificallyassociatedwithyourpaymentgate-wayaccount.However,theAPILoginIDandTransactionKeyareNOTusedforloggingintotheMerchantInterface.The-setwovaluesareonlyrequiredwhensettingupanInternetconnectionbetweenyoure-commerceWebsiteandthepaymentgateway.TheyareusedbythepaymentgatewaytoauthenticatethatyouareauthorizedtosubmitWebsitetransactions.Transactionsthatcannotbeauthenticatedbythepaymentgatewayusingthesevaluesarerejected.
IMPORTANT:TheAPILoginIDandTransactionKeyprotectyourpaymentgatewayaccountfromunauthorizeduseandshouldnotbesharedwithanyone.BesuretostorethesevaluessecurelyonaserverseparatefromyourWebserverandchangetheTransactionKeyregularlytofurtherstrengthenthesecurityofyouraccount.
TocreateanAPILoginIDorTransactionKeyforthefirsttime:
Step1:TypeinyourSecretAnswer.YoushouldhaveconfiguredaSecretQuestionandSecretAnswerduringac-countactivation.Step2:ClickSubmittocontinueorclickCanceltocanceltheaction.TheAPILoginIDandTransactionKeygen-eratedforyourpaymentgatewayaccountappear.
OnceyouhaveinitiallycreatedyourAPILoginID,youmaynotchangeitintheMerchantInterface.TochangeyourAPILoginID,pleasecontactAuthorize.NetCustomerSupport.
IMPORTANT:TheAPILoginIDisdifferentthanyouruserloginID.YouruserloginIDallowsyoutologintoyourMer-chantInterfaceuseraccount.TheAPILoginIDgrantsamerchantaccesstosubmittransactionstothepaymentgate-way.
Youmayobtainanew,uniqueTransactionKeyonthispageasoftenasneeded.
Toobtainanewtransactionkey:
Step1:EnteryourSecretAnswer(theanswertoyourSecretQuestionconfiguredataccountsetup).Step2:Todisabletheoldtransactionkey,clickthecheckboxlabeledDisableOldTransactionKey.Note:IftheDisableOldTransactionKeycheckboxisnotselected,theoldtransactionkeywillautomaticallyex-pirein24hours.Step3:ClickSubmittocontinueorclickCanceltocanceltheaction.Yournewtransactionkeyisdisplayed.
68 QMerchantManual
August27,2019
TIPS
TESTYOURCONNECTIONTOTHEPAYMENTPROVIDER:StartQMerchantandmakesurethatyouhaveyourpaymentproviderselectedinthesettingsdialog.Makesurethatthetestmode ischecked.ThenfromtheToolsmenuselect ‘VirtualTerminal’.Fill ina totalamount;entersomedigitsascreditcardnumber.Addtheexpirationdateandpress‘Submit’.Ifyoucanconnecttoyourpaymentproviderthenyouwillreceiveanerrormessage,thateitheryouraccountisinvalidorthecreditcardnumberiswrongorso.Thisprovesthatyoucorrectlycanconnecttothepaymentproviderandsubmittransactions.
GETTHEQMERCHANTVERSIONANDSERIALNUMBERFromtheQMerchantmenubarselectInformationandthenAbout.IntheAboutdialogclicktheDetailsbutton.
69 QMerchantManual
August27,2019
TROUBLESHOOT
PrerequisitesCurrentMinimumPrerequisitesare:
• WindowsXP,WindowsVista,Windows7,Windows8• Microsoft.NetFramework4.0rev.5,• QuickBooks2004-2018Pro,Premiere,EnterpriseUSorCAversionor
QuickBooksPointofSale• Avalidmerchantpaymentprovideraccount.
HowdoIgetthetransactionkeyfromAuthorize.Net?
Openyourwebbrowserandnavigatetohttp://www.authorize.net.Login intoyouraccountandgototheAccountSettings. In thesection ‘SecuritySettings’ isa link to thetransactionkey.Followthat linkandacquirethetransactionkey.
IseethefollowingmessagefromAuthorize.Net
Theloginandpasswordinformationyouspecifiedisnotcorrect.YouwillfirstneedtologintoyourAuthorize.NetaccountandgotoSettings>APILoginIDandTransactionKey.ThereyouwillacquireyourAPILoginandyourTransactionKey.SimplyreplacetheloginandtransactionkeywithinQMerchantwithyourAPILoginandTransactionKey.
SupportedPaymentGateways:
Authorize.Net http://www.authorize.net
PayTrace http://www.paytrace.com
PPIPaymover http://www.ppipaymover.com
Ifyouhaveadifferentpaymentprovider,pleasecontactourhelpdesk.
HowcanIseetheauthorizationandtransactionidofasalesreceipt?
InQuickBooksDesktopversions,weaddedacustomfieldQ_Authorization.PleaseaddthistoyoursalesreceiptlayoutinQuickBooks.
70 QMerchantManual
August27,2019
InQuickBooksPointofsale,pleaseusethesaleshistorytogetthereferencenumberofthesale.Thenopenthemenuitem‘Viewsalesreceiptbyrefnumber’fromtheinformationmenuandenterthereferencenumber.Therequiredinformationisdisplayed.
CannotgetthecreditcardnumberfromQuickBooks
Theccnumberisshownas******…only.IntuitdoesnotallowanylongerretrievingthecreditcardnumbersstoredinQuickBooksinanun-maskedformat.So,whenweretrievethatnumber,itisshowninourpaymentdi-alogmasked,practicallyunusable.Tousethisnumberagain,youeitherhavetore-typeitorcopyandpasteitfromQuickBooks.
Tosolvethisproblemyoucanstorethecreditcardnumberatanotherplaceorinacustomfieldwiththecus-tomerinQuickBooks.Thatwayyoucanovercomethisrestriction.Itisaone-timecopyandpasteprocess.
1. YoucanusetheAccountNo.fieldofthecustomerpaymentinfo.IntheQMerchantcustomsettingspleaseenterasvalueintheCCNumberFieldNametheexpression//CustomerRet/AccountNumber.Thisisthede-fault.WerecommendthisbecauseyoustillhaveallpaymentinformationinQuickBooksatthesametab.
2. Useanadditionalorcustomfield:
Createforyourcustomeranadditionalorcustomfieldnamedi.e.CCNumber.Youhavetodefineitonlyonce.Itisautomaticallypropagatedtoallcustomers.Thencopyandpastethecreditcardnumberfromthecustomerpaymentinfointothenewfield.Leaveeverythingelselikeexpdateetc.attheQuickBookspaymentinfo.
TheninQMerchantselectfromthe'Information'menu'Support'andthen'CustomSettings'.OKthemessagebox.Inthefollowingdialog,thereisafieldnamedCCNumberFieldName.ClickinthecolumnrightoffthatnameandenterCCNumber(thenameofyourcustomfieldfromabove).Clickoktosaveit.
NowQMerchantwillgrabthecreditcardnumberfromthatcustomfield.
QuickBooksDesktopVersionsi.e.EnterpriseandWindows7
IcannotconnecttoQuickBooks.TypicallythisisaproblemwithnewerQuickBooksversionandWindowsac-countcontrol.Intuitrecommendsthefollowing:PleaseopeninWindowstheControlPanelandsearchforUAC.ItislocationintheActionCenter.ClickChangeUserAccountControlandscrollthesliderdowntonevernotify.ClosethedialogwithOK.Closeallcontrolpaneldialogs.AlsocloseallQMerchantwindows.ThenrestartQMer-chantandtrytoconnectagaintoQuickBooks.
QUICKBOOKSPOINT-OF-SALEVERSIONS
IcannotconnecttoQuickBooksPOS.ThismayhappenwitholderQuickBooksPOSversions.PleasedownloadandinstalltheQBMXLPOSRuntime,whichallowstheaccesstoQuickBooksPOSfromthefollowinglink:http://www.addqin.com/download/QBPOSSDKRuntimeInstaller.exe
HowcanIdisabletheintegratedQuickBooksmerchantservice?
QuickBooksPOSv.10andbelow:IntheCompanyPreferences|MerchantandGiftServices,pleaseremovetheMerchantNumber.NewerQuickBooksPOSversions:
71 QMerchantManual
August27,2019
ChooseFile>SetupInterview.ClickthePaymentstab.SelectNoandthenclickDone.
OtherQuickBooks versions (Pro, Premiere, Enterprise):Make sure the checkbox 'Process ... credit card pay-ment'isuncheckedallthetimewhenyousaveasalesreceipt,areceivepaymentoracreditmemo.
Errormessage‘Markettypeisinvalid.
IamtryingtouseQMerchantwithAuthorize.netforpayment.whenIprocessthepaymentIgetANerrormes-sage itsays ‘Markettype is invalid’.Authorize.nethastwotypesofaccounts:CP=CardPresentorCNP=CardnotPresent.Dependingonthetypeoftheaccountyoumust intheQMerchantsettingscheckorunchecktheCheckbox‘CPAccount’.CPAccountCheck=CP,CPAccountuncheck=CNP.Pleasereversethestateofthecheckbox.
IwanttochangetheQuickBooksversionIselectedduringinstallation.
DuringInstallationyoucanselectbetweenNone,QuickBooksPointofSaleandQuickBooksPro,PremiereorEn-terprise.Toreversethisdecision,pleasedothefollowing:StartQMerchant.FromtheToolsmenuselectSetupWizardandfollowtheinstructions.
Ifyouhaveanyquestionsorexperienceotherproblems,pleasevisitourhelpdeskathttp://www.addqin.com
72 QMerchantManual
August27,2019
APPENDIXA:SCREENSHOTSFORTHEUSEWITHQUICKBOOKSPOINT-OF-SALE(OLDERVERSIONS)Createasale.
Afteryoufinishedpressthe‘TakePayment’button.
SelectCreditCardasPayment.AdialogtoselecttheCreditCardtypeappears.Maketheappropriateselection.
73 QMerchantManual
August27,2019
Choosethepaymenttypeandreturntothepreviousscreen.
Press“SaveOnly”orSave&Print”.NowyouarefinishedwiththeQuickBookspartofthepayment.NavigatetotheQMerchantDashboardandpress“GetPayment”
74 QMerchantManual
August27,2019
ThesalesreceiptisrequestedfromQuickBooks–PointofSaleandpresentedasfollows:
Completetheyellowfieldseitherbyswipingacreditcardorbyenteringthemmanually.ThenPress‘Submit’totransferthedatatoyourpaymentprocessor.Aftercompletionyouseeamessageboxwiththeresult.DependingonyourQuickBooks–PointofSaleversion,QMerchantwilladdthetransactionidandtheauthorizationcodetothesalesreceiptinQuickBooksPOS.Youalsocanhardcopyareceiptwiththe‘Print’button.Haveinmind,thetransactionisrecordedinQuickBooks,eveniftheprocessingyourpaymentprocessorfails.So,youareresponsibletotakecorrectiveactions.
75 QMerchantManual
August27,2019
APPENDIXB:AUTHORIZE.NETRESPONSECODES(EXCERPTFROMAUTHORIZE.NETDOCUMENTATION)22Thistransactionhasbeendeclined.23Thistransactionhasbeendeclined.Thiscodeindicatesareferralresponse.24Thistransactionhasbeendeclined.Thecodereturnedfromtheprocessorindicatingthatthecardusedneedstobepickedup.35Avalidamountisrequired.Thevaluesubmittedintheamountfielddidnotpassvalidationforanumber.36Thecreditcardnumberisinvalid.37Thecreditcardexpirationdateisinvalid.Theformatofthedatesubmittedwasincorrect.38Thecreditcardhasexpired.3 11 A duplicate transaction has been submitted. A transactionwith identical amount and credit card infor-mationwassubmittedtwominutesprior.312Anauthorizationcodeisrequiredbutnotpresent.313ThemerchantLoginIDisinvalidortheaccountisinactive.315ThetransactionIDisinvalid.ThetransactionIDvalueisnon-numericorwasnotpresentforatransactionthatrequiresit(i.e.,VOID,PRIOR_AUTH_CAPTURE,andCREDIT).316Thetransactionwasnotfound.ThetransactionIDsentinwasproperlyformattedbutthegatewayhadnorecordofthetransaction.317Themerchantdoesnotacceptthistypeofcreditcard.Themerchantwasnotconfiguredtoacceptthecred-itcardsubmittedinthetransaction.319Anerroroccurredduringprocessing.Pleasetryagainin5minutes.320Anerroroccurredduringprocessing.Pleasetryagainin5minutes.321Anerroroccurredduringprocessing.Pleasetryagainin5minutes.322Anerroroccurredduringprocessing.Pleasetryagainin5minutes.323Anerroroccurredduringprocessing.Pleasetryagainin5minutes.325Anerroroccurredduringprocessing.Pleasetryagainin5minutes.326Anerroroccurredduringprocessing.Pleasetryagainin5minutes.227ThetransactionresultedinanAVSmismatch.Theaddressprovideddoesnotmatchbillingaddressofcard-holder.328Themerchantdoesnotacceptthistypeofcreditcard.TheMerchantIDattheprocessorwasnotconfig-uredtoacceptthiscardtype.330Theconfigurationwiththeprocessorisinvalid.CallMerchantServiceProvider.333FIELDcannotbeleftblank.ThewordFIELDwillbereplacedbyanactualfieldname.Thiserrorindicatesthatafieldthemerchantspecifiedasrequiredwasnotfilledin.334TheVITAL identificationnumbersare incorrect.CallMerchantServiceProvider.Themerchantwas incor-rectlysetupattheprocessor.335Anerroroccurredduringprocessing.CallMerchantServiceProvider.Themerchantwasincorrectlysetupattheprocessor.336Theauthorizationwasapproved,butsettlementfailed.337Thecreditcardnumberisinvalid.339Thesuppliedcurrencycodeiseitherinvalid,notsupported,notallowedforthismerchantordoesn’thaveanexchangerate.340Thistransactionmustbeencrypted.347Theamountrequestedforsettlementmaynotbegreaterthantheoriginalamountauthorized.Thisoccursifthemerchanttriestocapturefundsgreaterthantheamountoftheoriginalauthorization-onlytransaction.348Thisprocessordoesnotacceptpartialreversals.Themerchantattemptedtosettleforlessthantheorigi-nallyauthorizedamount.349Atransactionamountgreaterthan$99,999willnotbeaccepted.
76 QMerchantManual
August27,2019
350Thistransactionisawaitingsettlementandcannotberefunded.Creditsorrefundsmayonlybeperformedagainstsettledtransactions.Thetransactionagainstwhichthecredit/refundwassubmittedhasnotbeenset-tled,soacreditcannotbeissued.351Thesumofallcreditsagainstthistransactionisgreaterthantheoriginaltransactionamount.352Thetransactionwasauthorized,buttheclientcouldnotbenotified;thetransactionwillnotbesettled.354Thereferencedtransactiondoesnotmeetthecriteriaforissuingacredit.355Thesumofcreditsagainstthereferencedtransactionwouldexceedtheoriginaldebitamount.Thetransac-tionisrejectedifthesumofthiscreditandpriorcreditsexceedstheoriginaldebitamount.357Anerroroccurredinprocessing.Pleasetryagainin5minutes.358Anerroroccurredinprocessing.Pleasetryagainin5minutes.359Anerroroccurredinprocessing.Pleasetryagainin5minutes.360Anerroroccurredinprocessing.Pleasetryagainin5minutes.361Anerroroccurredinprocessing.Pleasetryagainin5minutes.362Anerroroccurredinprocessing.Pleasetryagainin5minutes.363Anerroroccurredinprocessing.Pleasetryagainin5minutes.366Thistransactioncannotbeacceptedforprocessing.Thetransactiondidnotmeetgatewaysecurityguide-lines.368Theversionparameterisinvalid.Thevaluesubmittedinx_cpversionwasinvalid.369Thetransactiontypeisinvalid.Thevaluesubmittedinx_typewasinvalid.370Thetransactionmethodisinvalid.Thevaluesubmittedinx_methodwasinvalid.3 72 The authorization code is invalid. The value submitted in x_auth_codewasmore than six characters inlength.374Thedutyamountisinvalid.Thevaluesubmittedinx_dutyfailedformatvalidation.375Thefreightamountisinvalid.Thevaluesubmittedinx_freightfailedformatvalidation.376Thetaxamountisinvalid.Thevaluesubmittedinx_taxfailedformatvalidation.378TheCardCode(CVV2/CVC2/CID)isinvalid.Thevaluesubmittedinx_card_codefailedformatvalidation.384Thedevicetypeisinvalid.Thevaluesubmittedinx_device_typedidnotmatchtheconfiguredvalue.385Themarkettypeisinvalid.Thevaluesubmittedinx_market_typedidnotmatchtheconfiguredvalue.386Theresponseformatisinvalid.Thevaluesubmittedinx_response_formatwasnotequalto“0”or“1.”387Thismarkettypeisnotsupported.388TheTrack1dataisinvalid.389TheTrack2dataisinvalid.390ACHtransactionscannotbeprocessed.ACHtransactionscannotbeprocessedbythecard-presentsystem.3103Thistransactioncannotbeaccepted.Avalidfingerprint,transactionkey,orpasswordisrequiredforthistransaction.3111Avalidbillingcountryisrequired.ThiscodeisapplicabletoWellsFargoSecureSourceSMmerchantsonly.3 112 A valid billing state/province is This code is applicable toWells Fargo required. SecureSourceSMmer-chantsonly.3120Anerroroccurredduringprocessing.Pleasetryagain.Thesystem-generatedvoidfortheoriginaltimedouttransactionfailed.(Theoriginaltransactiontimedoutwhilewaitingforaresponsefromtheauthorizer.)3121Anerroroccurredduringprocessing.Pleasetryagain.Thesystem-generatedvoidfortheoriginalerroredtransactionfailed.(Theoriginaltransactionexperiencedadatabaseerror.)3122Anerroroccurredduringprocessing.Pleasetryagain.Thesystem-generatedvoidfortheoriginalerroredtransactionfailed.(Theoriginaltransactionexperiencedaprocessingerror.)3123Thisaccounthasnotbeengiventhepermission(s)requiredforthisrequest.ThetransactionrequestmustincludetheAPILoginIDassociatedwiththepaymentgatewayaccount.2 127 The transaction resulted in an AVSmismatch. The address provided does notmatch billing address ofcardholder.Thesystem-generatedvoidfortheoriginalAVSrejectedtransactionfailed.3128Thistransactioncannotbeprocessed.Thecustomer’sfinancialinstitutiondoesnotcurrentlyallowtrans-actionsforthisaccount.
77 QMerchantManual
August27,2019
2 141 This transaction has been declined. The system-generated void for the original FraudScreen-rejectedtransactionfailed.2 145 This transaction has beendeclined. The system-generated void for the original card code-rejected andAVS-rejectedtransactionfailed.3152Thetransactionwasauthorized,buttheclientcouldnotbenotified;thetransactionwillnotbesettled.Thesystem-generatedvoidfortheoriginaltransactionfailed.Theresponsefortheoriginaltransactioncouldnotbecommunicatedtotheclient.2165Thistransactionhasbeendeclined.Thesystem-generatedvoidfortheoriginalcardcode-rejectedtransac-tionfailed.3170Anerroroccurredduringprocessing.Pleasecontactthemerchant.ConcordEFS–Provisioningatthepro-cessorhasnotbeencompleted.3171Anerroroccurredduringprocessing.Pleasecontactthemerchant.ConcordEFS–Thisrequestisinvalid.3172Anerroroccurredduringprocessing.Pleasecontactthemerchant.ConcordEFS–ThestoreIDisinvalid.3173Anerroroccurredduringprocessing.Pleasecontactthemerchant.ConcordEFS–Thestorekeyisinvalid.3174Thetransactiontypeisinvalid.Pleasecontactthemerchant.ConcordEFS–Thistransactiontypeisnotac-ceptedbytheprocessor.3175Theprocessordoesnotallowvoidingofcredits.ConcordEFS–Thistransactionisnotallowed.TheCon-cordEFSprocessingplatformdoesnotsupportvoidingcredittransactions.Pleasedebitthecreditcardinsteadofvoidingthecredit.3180Anerroroccurredduringprocessing.Pleasetryagain.Theprocessorresponseformatisinvalid.3181Anerroroccurredduringprocessing.Pleasetryagain.Thesystem-generatedvoidfortheoriginal invalidtransactionfailed.(Theoriginaltransactionincludedaninvalidprocessorresponseformat.)3185Thistransactioncannotbeprocessed.MerchantisnotconfiguredforVPOS.2 201 This transactionhas beendeclined. The expirationdate is invalid. This error code applies only tomer-chantsonFDCOmaha.2202Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thetransac-tiontypeisinvalid.2203Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thevaluesubmittedintheamountfieldisinvalid.2 204 This transactionhasbeendeclined. This error code applies only tomerchants on FDCOmaha. Thede-partmentcodeisinvalid.2205Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thevaluesubmittedinthemerchantnumberfieldisinvalid.2206Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Themer-chantisnotonfile.2207Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Themer-chantaccountisclosed.2208Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Themer-chantisnotonfile.2209Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Communica-tionwiththeprocessorcouldnotbeestablished.2210Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Themer-chanttypeisincorrect.2211Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thecard-holderisnotonfile.2212Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thebankconfigurationisnotonfile2213Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Themer-chantassessmentcodeisincorrect.2214Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thisfunc-tioniscurrentlyunavailable.
78 QMerchantManual
August27,2019
2 215 This transactionhasbeendeclined. This error code applies only tomerchants on FDCOmaha. Theen-cryptedPINfieldformatisinvalid.2216Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.TheATMtermIDisinvalid.2217Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thistransac-tionexperiencedageneralmessageformatproblem.2218This transactionhasbeendeclined. This error codeappliesonly tomerchantson FDCOmaha. ThePINblockformatorPINavailabilityvalueisinvalid.2219Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.TheETCvoidisunmatched.2220Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.TheprimaryCPUisnotavailable.2 221 This transaction has been declined. This error code applies only tomerchants on FDCOmaha. The SEnumberisinvalid.2222Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Duplicateauthrequest(fromINAS).2223Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Thistransac-tionexperiencedanunspecifiederror.2224Thistransactionhasbeendeclined.ThiserrorcodeappliesonlytomerchantsonFDCOmaha.Pleasere-enterthetransaction.