suncorp bank virtual pos batch loader manual
TRANSCRIPT
2 Suncorp Bank
CopyrightSuncorp Bank and its vendors own the intellectual property in this Manual exclusively. You acknowledge that you must not perform any act which infringes the copyright or any other intellectual property rights of Suncorp Bank or its vendors and cannot make any copies of this Manual unless in accordance with these terms and conditions.
Without our express written consent you must not:
• DistributeanyinformationcontainedinthisManualtothepublicmediaorquoteorusesuchinformationinthepublicmedia; or
• AllowaccesstotheinformationinthisManualtoanycompany,firm,partnership,association,individual,groupofindividualsorotherlegalentityotherthanyourofficers,directorsandemployeeswhorequiretheinformationforpurposesdirectlyrelatedtoyourbusiness.
License AgreementThesoftwaredescribedinthisManualissuppliedunderalicenseagreementandmayonlybeusedinaccordancewiththeterms of that agreement.
TrademarksAllthird-partyproductandservicenamesaretrademarksorregisteredtrademarksoftheirrespectiveowners.
Suncorp Bank GPO Box 1453 BrisbaneQLD4001 Phone 13 11 75 www.suncorpbank.com.au
3Virtual POS Batch Loader Manual – August 2013
ContentsUsing this Manual 5Purpose 5Related Documents 5Other Software Dependencies 5Essential Knowledge 6Distribution 6Functional Overview 6Prerequisites 6Two Step Manual Processing Cycle 7Input and Output File Format 7Input and Output File Locations 7Validate Only Cycle 7Processing Cycle 8Windows Installation 9Installation Package 9Installation Process 9Post Installation Configuration 12Using the Batch Loader 13Starting the Batch Loader in Windows 13The Validate Only Cycle 13 1. Batch File Input Directory 13 2. Opening a Batch File 14 3. Ensuring that “Validate Only” is Checked 14 4. Starting the “Validate Only” Cycle 15 5. Checking the Results from the “Validate Only” Cycle 15 6. Amending the Input Batch File 16The AMA Configuration Screen 17The Processing Cycle 17 7. Ensuring that “Validate Only” is Cleared 18 8. Starting the “Processing” Cycle 18 9. Waiting for the “Processing” Cycle to Finish 19 10. Checking the Results from the “Processing” Cycle 19Business Processes for Declined and Error Transactions 20Refunding Transactions 20Before Uninstalling the Batch Loader 20Uninstalling the Batch Loader in Windows 20Advanced Functions 21Automating Batch Loader 21Custom input directory 21Recurring Payments 22
4 Suncorp Bank
Appendix A 23Appendix B 26ERRBATCHLOADER (BatchLoader Configuration Errors) 26ERRRECORD (Batch File Record Errors) 27ERRPC (Payment Client Errors) 27Appendix C 28BATCHLINESTANDARD 28BATCHLINESTANDARD – Refund – Input Format 29BATCHLINESTANDARD – Refund – Output Format 30BATCHLINESTANDARD – Example 30
5Virtual POS Batch Loader Manual – August 2013
Using this ManualThis section contains information that helps you understand and use the information contained in this manual.
PurposeTheBatchLoaderisanapplicationfacilitatingthebatchedprocessingofcreditcardtransactions.
ThisBatchLoaderR2.0UserManualhelpsenduserstounderstandtheinstallationandoperationalrequirementsoftheBatchLoaderapplication.
Related DocumentsThisdocumentisintendedtobeusedwithreferencetovariousotherdocumentsdetailingsystemsthatthisapplicationdependsupon.Thereaderisadvisedtoconsultthefollowingdocumentstogainanin-depthunderstandingoftheapplication:
Document Name
MerchantAdministrationGuide
Other Software DependenciesTheBatchLoaderdependsuponthefollowing3rdpartysoftware:
Software Version URL
JavaRuntimeEnvironment SUNJRE6 http://java.sun.com/
OR OR
JavaDevelopmentKit SUNJDK6
Furthermore,theapplicationrequiresconnectivitytotheinternetinordertosendtransactionstothePaymentServer.
6 Suncorp Bank
Essential KnowledgeDistributionTheBatchLoaderinstallationpackageisdistributedtomerchantswhohavebeenapprovedbySuncorpBankforthebatchedprocessing of transactions.
NotetheBatchLoaderinstallationpackagemustNOTberedistributedwithoutthepriorconsentofSuncorpBank.
Functional OverviewThefollowingdiagramdepictsthecommunicationbetweentheBatchLoaderandvariouscomponentsoftheMiGSservice:
CommunicationbetweentheBatchLoaderandtheServer
AstheBatchLoadercommunicateswiththeserverviaVirtualPOS,theBatchLoadermustonlyuseMerchantIDslinkedtothekeysinVirtualPOS.
Pre requisitesSUNJRE/JDKmustbeinstalledpriortotheinstallationoftheBatchLoader.Pleaserefertothe“RelatedDocuments”and“OtherSoftwareDependencies”forfurtherinformationonobtainingandinstallingthissoftware.
Furthermore,avalidMerchantIDmustbeactiveontheMiGSservice,withthefollowing“GlobalPermissions”enabled:
VirtualPOS
MOTO
RefundsprocessingrequiresanAdvancedMerchantAdministrationusernameandpassword.
7Virtual POS Batch Loader Manual – August 2013
Two Step Manual Processing CycleVITALINFORMATION:MerchantsoperatingtheBatchLoaderapplicationmanuallymustprocesstransactionsinatwostepprocess:
1.ValidateOnlyCycle–thisprocessprescreenstheinputfileforcommonlyknownerrors,andoutputsinformationonwhichtransactionsarecorrectlyformatted,andwhichtransactionswilldefinitelyfail.IntheValidateOnlyCycle,notransactionswillbesenttothePaymentServer.Thisallowsthemerchanttocorrectformattingerrors.Oncetheuserishappywithavalidatedinputfile,theymayproceedtothenextstep.
Note:theapplicationdefaultswiththevalidateonlyoptionenabled,howevertheusermaymanuallyskipthisstep.Validationishighlyrecommendedtoreducereworkonfailedtransactions.
ProcessingCycle–thisprocesswillsendtransactionstothePaymentServer.Anytransactionsthathadfailedvalidation,buthadnotbeencorrected,willnotbesenttotheserver.
Note:indepthinformationonusingtheapplicationwillbedetailedinthesection“UsingtheBatchLoader”.
AutomaticProcessingCycle-AutomaticProcessingwillbecoveredintheAdvancedSectionofthismanual.
Input and Output File FormatTheBatchLoaderapplicationprocessestransactioncommandsfromcommaseparatedvalue(CSV)inputfiles.Likewise,itoutputsresultstoCSVoutputfiles.
Input and Output File LocationsTheBatchLoaderapplicationpicksupinputfilesfromthefollowingsubdirectory:
<BATCHHOME>\batchin(bydefault)
and generates output files in:
<BATCHHOME>\batchout(enforced)
where<BATCHHOME>isthedirectoryinwhichtheapplicationhasbeeninstalled.Theusermayselectinputfilesfromotherdirectories,howevertheoutputfileswillalwaysbegeneratedinthe“batchout”directory.
Validate Only Cycle
IntheValidateOnlyCycle,userscanvalidatethefile,makeanyadjustmentsnecessary,andvalidatethefileagain.Thereisnolimitonthenumberoftimesafilecanbevalidated.
Note: the output filenames are prefixed with the input filename. This is to allow easy identification of results.
8 Suncorp Bank
Processing Cycle
IntheProcessingCycle,thefile.csv.statefileisusedtokeeptrackofwhichlinesintheinputfile.csvhasbeenprocessed.Shouldtheprocessbeinterrupted,processedtransactionswillnotbesentagain.Theprogramwillresumeatthefirstunprocessed transaction.
Note:theapplicationkeepstrackofresultsandprocessedtransactionsviatheuniquefilename.OncetheProcessingCyclehasbeeninitiated,theuserMUSTNOTCHANGE/DELETEthefilenamesorcontentsofthefilesillustratedabove.
The declined file.csv.dec.csv and error file.csv.err.csv files contain declined and error transactions exactly as they appear intheinputfile.Theusercanmakeacopyofthesefiles,makeanycorrectionsnecessary,andreprocessthesefailedtransactions.NOTE:itisrecommendedthattheuserdoesnotchangethedeclinedanderroroutputfiles,butrathermakeadifferent copy for reprocessing. The user can copy these files to the input directory and make modifications there.
9Virtual POS Batch Loader Manual – August 2013
Windows InstallationThissectioncontainsinformationontheinstallationandgeneralconfigurationoftheBatchLoader.
Installation PackageTheBatchLoaderisdistributedviaapackagenamed:
vpcbatch_<version>_MiGS.exe
where<version>isthecurrentversionoftheapplication.Toinitiatetheinstallationprocess,doubleclicktheinstallationpackage:
Installation Process
Theinstallationprogramwillbeginwithan“Introduction”screen.ClickNexttoproceed.
10 Suncorp Bank
A“ChooseJavaVirtualMachine”screenwillbedisplayed.AlistofrecognisedJavaVirtualMachines(JVMs)willbelisted.
Note:ThecorrectJVMasspecifiedinthesection“OtherSoftwareDependencies”isrequired.
ClickNexttoproceed.
A“ChooseInstallFolder”screenwillbedisplayed.Itisrecommendedthatthedefaultfoldershouldbeused. ClickNexttoproceed.
11Virtual POS Batch Loader Manual – August 2013
A“ChooseShortcutFolder”screenwillbedisplayed.Itisrecommendedthatthedefaultfoldershouldbeused. ClickNexttoproceed.
A“Pre-InstallationSummary”screenwillbedisplayed.Oncetheuserhascheckedthesettings,clickInstalltoproceed.
Aprogressscreenwillbedisplayed.Pleasewaitwhiletheapplicationisinstalled.
Oncetheinstallationiscomplete,an“InstallComplete”screenwillbedisplayed.ClickDonetocompletetheinstallationprocess.
12 Suncorp Bank
Post-Installation Configuration
Allfollowingconfigurationsaredonebymodifyingthe‘BATCHLOADER.properties’filelocatedin<batchhome>\classesfolder(defaultC:\MiGS\VPCBatchLoader\classes)
Pleaseopenthisfile‘BATCHLOADER.properties’byusinganytexteditor,suchasnotepadorwordpad.
1.InstallationPatchsetting(Youmightskipthisstep,ifyouinstallthebatchloadbyusingdefaultinstallationpatch.)
Lookfor‘BATCHLOADER_ROOT’,andinputthecorrectpatchfortheBatchLoader.
Examples
BATCHLOADER_ROOT=C:\\MiGS\\BatchLoader
2.Lookfor‘MIGS.TARGETURL’
PleasemarksuretheURLis‘https://migs.mastercard.com.au/vpcdps’.
MIGS.TARGETURL=https://migs.mastercard.com.au/vpcdps
3.Lookfor‘ACCESSCODE’
PleaseinputtheAccesscodeyouretrivedfromMerchantAdministration(MA)portalorfromSuncorpBank.
FordetailedinformationonthesettingsconfigurableintheBATCHLOADER.propertiesconfigurationfile,pleaserefertoAppendixA.
13Virtual POS Batch Loader Manual – August 2013
Using the Batch LoaderThissectioncontainsinformationontheoperationoftheBatchLoaderapplication.
Starting the Batch Loader in WindowsAsmentionedinaprevioussection,theBatchLoadercanbestartedvia:
Start->Programs->MiGSVPCBatchloaderR2.0->Load
An“ERRBATCHLOADER”screenwillbedisplayedifthereisanerror.PleaserefertoAppendixB.
The Validate Only CycleOncetheBatchLoaderhasbeensuccessfullystarted,themain“Loader”screenwillbedisplayed.
Themain“Loader”screenistheinterfacethroughwhichtheuserwillcarryoutthebatchprocessingtask.Noticethatthe“BatchFile”fieldiscurrentlyblank,andthatthe“Load”buttonisdisabled.
1. Batch File Input Directory
Batchfilesshouldbeplacedinthefollowingdirectory:
<BATCHHOME>\batchin
Thiswillallowtheapplicationtoeasilylocatethebatchfilestobeprocessed.Althoughitisnotmandatoryforbatchfilestobeplacedinthisdirectory,itishighlyrecommendedsothattheusercankeeptrackofalltheirfiles.
Note:batchfilesmusthaveauniquefilename.Asdetailedinthesection“InputandOutputFileLocations”,theapplicationkeeps results and status information according to the input filename.
14 Suncorp Bank
2. Opening a Batch File
Toselectabatchfile,clickontheOpenbuttonfromthe“MainLoader”screen.Anexamplebatchfileisincludedintheinstallationpackage.SelectthebatchfileandclicktheOpenbutton.
3. Ensuring that “Validate Only” is Checked
Bydefault,theValidateOnlycheckboxistickedwhenabatchfileisselected.Becausethisoptionisselected,notransactionswillbesenttotheserver;transactionsinthebatchfilewillbecheckedforcommonformattingerrors.
Noticethatthe“BatchFile”fieldwilldisplaythefilenameoftheselectedbatchfile.Onceabatchfilehasbeenselected,the“Load”buttonisenabledasillustratedabove.
15Virtual POS Batch Loader Manual – August 2013
4. Starting the “Validate Only” Cycle
ThevalidationcanbestartedviatheLoadbutton.
Theprogresswillbedisplayedwhilevalidationistakingplace.
5. Checking the Results from the “Validate Only” Cycle
Pleasewaitwhiletheapplicationperformsvalidation.Onceitiscomplete,theapplicationwilldisplay“FINISHED”inthe“Status”field.Severalresultsbuttonswillalsobeenabled.
16 Suncorp Bank
TheViewAllResultsbuttonwilldisplaythevalidationstatusofalltransactionscontainedintheinputbatchfile.Thisincludesallvalidatedanderrorresults(file.csv.test.all.csv).
TheValidatedbuttonwilldisplaythevalidationstatusofallvalidatedtransactions(file.csv.test.app.csv).
TheErrorbuttonwilldisplaytheerrortransactionsexactlyasitappearsintheinputbatchfile(file.csv.test.err.csv).
PleaserefertoAppendixBandCfordetailedinformationonresultcodesandresultinformation.
Thefollowingisanexampleofthe.all.csvfilethatisdisplayedwhentheViewAllResultsbuttonispressed.
6. Amending the Input Batch File
Theusershouldtakenoteofanyerrortransactions,andmakeanymodificationsnecessary.Becausethisisthe“ValidateOnly”cycle,theusermaymakemodificationstotheoriginalinputbatchfile.
Theuserisencouragedtovalidatetheinputbatchfileuntilthebatchfileisdeemedfitforthe“Processing”cycle.
Torepeatthe“ValidateOnly”cycleaftermakingmodifications,theusershouldensurethattheValidateOnlyoptionisselected,andclickontheLoadbuttontorevalidate.
Note:themostcommonsourceofvalidationerrorsarefieldsthataretoolong/tooshort,orfieldsthatcontaininvalidinformation(forexampleacardnumberfailingMOD10check).
17Virtual POS Batch Loader Manual – August 2013
The AMA Configuration ScreenIftheinputbatchfilecontainstransactions,suchCaptureandRefund,requiring“AdvancedMerchantAdministration”usernamesandpasswords,theycanbeconfiguredinthe“AMAConfiguration”screen.
TheAMAUsercanbecreatedbylogintoMerchantAdministrationPortal.PleaserefertotheMerchantAdministrationGuidefor more information.
Uptofive(5)AMAusernames/passwordscanbeconfigured.
The Processing CycleOncetheuserhasvalidatedthebatchfile,theymaybeginthe“Processing”cycle.
18 Suncorp Bank
7. Ensuring that “Validate Only” is Cleared
Tostartthe“Processing”cycle,ensurethatthe“ValidateOnly”checkboxisclearedasillustratedbelow.
Note:byclearingthe“ValidateOnly”checkbox,transactionswillbesenttotheserverwhenthe“Load”buttonispressed.
8. Starting the “Processing” Cycle
TheprocessingcanbestartedviatheSendFilebutton.
19Virtual POS Batch Loader Manual – August 2013
Aconfirmationpopupforthestartofthe“Processing”cyclewillappear.ClickYestoproceedorNotocancelprocessing.
9. Waiting for the “Processing” Cycle to Finish
Pleasewaitwhiletheapplicationperformsprocessing.Thetotaltimeisdependentonthesizeofthebatchfile,thespeedofthecomputer,thespeedoftheinternetconnection,andtheauthorisationtimetakenforeachtransaction.
TheprocessingcanbestoppedviatheStopbutton,theFile>Exitmenuitem,ortheXatthetoprightcorneroftheapplication.Iftheprocessingneedstobestopped,pleasewaitpatientlywhiletheapplicationfinishesofftransactionsthathavealreadybeensenttotheserver.
Note:theapplicationcannotbeclosedwhileabatchfileisbeingprocessed.IftheFile>Exitmenuitem,ortheXispressedwhileabatchisbeingprocessed,thiswillbeequivalenttopressingtheStopbutton.ToclosetheapplicationpresstheFile>ExitmenuitemortheXwhilebatchprocessinghasfinishedorhasstopped.
10. Checking the Results from the “Processing” Cycle
Oncethe“Processing”cycleiscomplete,theapplicationwilldisplay“FINISHED”inthe“Status”field.Severalresultsbuttonswillalsobeenabled.
TheViewAllResultsbuttonwilldisplaytheresultsofalltransactions.Thisincludesallapproved,declined,anderrorresults(file.csv.all.csv).
TheApprovedbuttonwilldisplaytheresultsofallapprovedtransactions(file.csv.app.csv).
TheDeclinedbuttonwilldisplaythedeclinedtransactionsexactlyasitappearsintheinputbatchfile(file.csv.dec.csv).
TheErrorbuttonwilldisplaytheerrortransactionsexactlyasitappearsintheinputbatchfile(file.csv.err.csv).
Anextrastatefile(file.csv.state)containstheinformationonwhichlinesoftheinputbatchfilehasbeenprocessed.Thisfileis for the internal use of the application only. PLEASE DO NOT EDIT OR REMOVE THIS FILE,thisisespeciallyimportantiftheprocessingwasstoppedbeforeitwasfinished,asthisfileallowstheapplicationtoresumeprocessingatthelastunprocessed transaction.
20 Suncorp Bank
Business Processes for Declined and Error Transactions
Thedeclined(file.csv.dec.csv)anderror(file.csv.err.csv)filescontaintransactionscopiedfromtheinputbatchfile.Theexactreasonforthedecline/errorshouldbecrosscheckedwiththeresultsfile(file.csv.all.csv)andabusinessdecisionbemadewhether to correct and re process these transactions.
DONOTMODIFYTHESEFILESDIRECTLY–thesefilescanbecopiedbackintotheinputdirectoryasanewbatchfile.Pleaserenameittoauniquebatchfilename.
Refunding Transactions
Theapprovedresultsfilefile.csv.app.csvcontainsthenecessaryinformationforprocessingrefunds.DONOTMODIFYTHISFILEDIRECTLY–thisfilecanbecopiedbackintotheinputdirectoryasanewbatchfile.Pleaserenameittoauniquebatchfilename.
The“TXNTYPE”fieldcanbechangedfromachargetoarefund,whilethe“TRANSACTIONNO”canbeused.Allotherirrelevantfieldsshouldberemovedtoconformtotherefundsformat(seeAppendixC).
ThissectioncontainsinformationontheuninstallationoftheBatchLoaderapplication.
Before Un installing the Batch Loader
Note:beforeuninstallingtheBatchLoaderpleaseensurethatthebatchinandbatchoutdirectories(inputbatchfiles,andoutputresults)arebackedupinasafelocation.
Un installing the Batch Loader in Windows
TheBatchLoadercanbeuninstalledvia:
Start->Programs->BatchLoader->Uninstall
Follow the on screen instructions to un install the application.
21Virtual POS Batch Loader Manual – August 2013
Advanced FunctionsThissectioncontainsinformationontheadvancedfunctionsandsettingsoftheBatchLoaderapplication.
BeforeusersattempttoutilisetheseadvancefunctiontheyshouldhaveagoodunderstandingofhowtheBatchLoaderfunctions and the input/output formats.
Automating Batch Loader• BystartingtheBatchLoaderwithLoad_Auto.exetheBatchLoaderwillsearchthroughthebatchinandprocessallfilesthatstartswithcertainpattern(defaultis“Auto”).
Thispatterncanbechanged/definedin
\BatchLoader\classes\BATCHLOADER.properties
in the line
INPUT_PATTERN=Auto
• NextistoaddrunningLoad_Auto.exeasawindowsscheduledtask,pleasenavigateto:
Start>AllPrograms>Accessory>SystemTools>ScheduledTasks
• ClickonAddScheduledTask
• ClickonNext
• Click on Browse
• BrowsetotheBatchLoaderfolderandselectLoad_Auto.exe
• Selectdesiredfrequencyandtime.
Inthelogdirectorytherewillbealogfilecalledautotask.logwhichwillhavedetailsontheautomatedtasks.
For example:
WedMar1517:40:45EST2006 ROOTDIR=C:\MiGS\BatchLoader INPUT_DIRECTORY=C:\MiGS\BatchLoader\batchin OUTPUT_DIRECTORY=C:\MiGS\BatchLoader\batchout INPUT_PATTERN=Auto VALIDATE_ONLY=false Readytoprocess1inputfiles ...AutoProcessing C:\MiGS\BatchLoader\batchin\Auto_sampleStandard01.csv ...done#0 Finished auto processing
OperatingintheBackgroundTheBatchLoadercanberanhiddenautomatically.
RightclickonLoad_Auto.exe
Select Properties
Inthe“Target:”field,deletetheword“show”attheend.
NexttimetheBatchLoaderisrunfromLoad_Auto.exeitwillstartprocessingwithoutshowingitswindow.
Custom input directoryYou can define your own input directory in
\BatchLoader\classes\BATCHLOADER.properties
byremovingthe#infrontoftheline
INPUT_DIRECTORY=C:\\MiGS\\BatchLoader\\MERCHANT_DEFINED
22 Suncorp Bank
Recurring PaymentsUsermaysendanemptyexpirydatefieldifoptionalexpirydateisactivated.
Forexample,apurchasetransactionlinewillbe:
C,MERCHANTID,MERCHREF,5123456789012346,,123,500,ORDERINF
Toactivatetheoptionalexpirydate,userswillhavetoopenthe“BATCHLOADER.properties”fileintheclassesfolder;Anduncommenttheline:(takeawaythe#)
#RECURPAY_CARDEXP=Optional
Duringvalidation,ifnoExpDateisspecifiedoritisall“spaces”,itwillpassvalidation.Iftheexpdatehasanythingotherthanspaces,validationwillstillcheckforitsformatingaspernonrecurringpayments.
Note:Themerchantaccounthastobesetupbytheirbanktosend“RecurringTransactionSubtype”asdefault,beforetheycanutiliserecurringpayments.Pleaseconsultyourbank.
23Virtual POS Batch Loader Manual – August 2013
Appendix ABATCHLOADER.properties
Below is an example listing for the configuration file.
################################################################################
#Copyright2007MasterCardInternational
#BATCHLOADER.properties-MiGSVPCBatchLoaderConfigurationFile
#
#Linesthatareprefixedwith“#”arecommentslines.
#LinesthatareNOTprefixedwith“#”aresettingslines.
#Linesthatappearmorethanoncewilltakethevaluefurthestdowninfile.
################################################################################
#-------------------------------------------------------------------------------
#BATCHLOADER_ROOT
#Mustbesettothebatchinstallationdirectory.NotethatWindows
#directoriesareseparatedbydoublebackslash\\andthereisnotrailing\\
#----------------------------------------------------------------------------
#Examples
#BATCHLOADER_ROOT=C:\\MiGS\\BatchLoader
#-------------------------------------------------------------------------------
BATCHLOADER_ROOT=\\MiGS\\VPCBatchLoader
#-------------------------------------------------------------------------------
#INPUT_DIRECTORY
#UserDefinedInputDirectory,defaultis“\\BatchLoader\\batchin”
#-------------------------------------------------------------------------------
#INPUT_DIRECTORY=C:\\MiGS\\VPCBatchLoader\\MERCHANT_DEFINED
#-------------------------------------------------------------------------------
#RECURPAY_CARDEXP
#Uncommentthelinebelowandthebatchloaderwillnotchecktheexistence
#ofthecardexpirydate.(Forrecurringpayments)
#-------------------------------------------------------------------------------
RECURPAY_CARDEXP=Optional
#-------------------------------------------------------------------------------
#INPUT_PATTERN
#OnlybatchfilenamesthatstartswiththedefinedINPUT_PATTERNwillexecute
#whentheBatchLoaderisinAutoMode.
#-------------------------------------------------------------------------------
INPUT_PATTERN=Auto
24 Suncorp Bank
#-------------------------------------------------------------------------------
#BATCHLOADER_DOFORMAT
#Mustbesettotheinputfileformat.Refertodocumentationfordetails.
#----------------------------------------------------------------------------
#Examples
#BATCHLOADER_DOFORMAT=BATCHLINECUSTOM1
#BATCHLOADER_DOFORMAT=BATCHLINESTANDARD
#-------------------------------------------------------------------------------
BATCHLOADER_DOFORMAT=BATCHLINESTANDARD
#BATCHLOADER_DOFORMAT=BATCHLINECUSTOM1
#-------------------------------------------------------------------------------
#BATCHLOADER_CCMASK16
#Maskingformatfor16digitcardnumbersinthe“.out.csv”resultsfile
#----------------------------------------------------------------------------
#Examples
#(DEFAULT)MaskALLdigits
#0.4Showonlythelast4digits
#6.3Showonlythefirst6andthelast3digits
#6.4Showonlythefirst6andthelast4digits
#NONENomasking,displayalldigits
#-------------------------------------------------------------------------------
BATCHLOADER_CCMASK=6.3
#-------------------------------------------------------------------------------
#AMAUsernameandPasswordConfiguration
#PresettheAMAmerchantIDandusernamesforrefundsprocessing
#----------------------------------------------------------------------------
#Examples
#BATCHLOADER_AMA_MERCHANT1_ID=TESTMERCHANT1
#BATCHLOADER_AMA_MERCHANT1_USER=user1
#-------------------------------------------------------------------------------
BATCHLOADER_AMA_MERCHANT1_ID=TESTMERCHANT1
BATCHLOADER_AMA_MERCHANT1_USER=AMA
BATCHLOADER_AMA_MERCHANT1_PASS=password123
BATCHLOADER_AMA_MERCHANT2_ID=TESTMERCHANT2
BATCHLOADER_AMA_MERCHANT2_USER=user2
BATCHLOADER_AMA_MERCHANT3_ID=TESTMERCHANT3
BATCHLOADER_AMA_MERCHANT3_USER=user3
BATCHLOADER_AMA_MERCHANT4_ID=TESTMERCHANT4
BATCHLOADER_AMA_MERCHANT4_USER=user4
BATCHLOADER_AMA_MERCHANT5_ID=TESTMERCHANT5
BATCHLOADER_AMA_MERCHANT5_USER=user5
25Virtual POS Batch Loader Manual – August 2013
################################################################################
#THEFOLLOWINGFIELDSMUSTNOTBECHANGED
################################################################################
BATCHLOADER_ECHO=BATCHLOADER_ECHO
BATCHLOADER_NAME=MiGSVPCBatchLoader
BATCHLOADER_VERSION=R2.0
################################################################################
#UNUSEDSETTINGS
################################################################################
#BATCHLOADER_COMPILATION=WIN32
#---LOGGING-------------------------------------------------------------------
#---WARNING:DONOTCHANGETHESEVALUESASTHISMAYLEADTOLOGGINGFAILURE.
log4j.rootCategory=DEBUG,MIGSAPPENDER
log4j.appender.MIGSAPPENDER=org.apache.log4j.ConsoleAppender
#log4j.appender.MIGSAPPENDER=org.apache.log4j.DailyRollingFileAppender
log4j.appender.MIGSAPPENDER.layout=org.apache.log4j.PatternLayout
log4j.appender.MIGSAPPENDER.layout.ConversionPattern=%d{yyyy-MM-ddHH:mm:ss.SSS}%-5p%c{1}%m%n
#-------------------------------------------------------------------------------
#TARGETURL
#TheVPCBatchloadernolongerreliesonthePaymentClienttopointtothe
#desiredURL.Thisconfigurationdefineswhereyouaresendingthebatchtransactions
#-------------------------------------------------------------------------------
#MIGS.TARGETURL=https://
MIGS.TARGETURL=https://migs.mastercard.com.au/vpcdps
#-------------------------------------------------------------------------------
#ACCESSCODE
#EveryMerchantIDwillhavetheiruniqueAccessCode.Itcanberetrievedfrom
#yourMerchantAdministrationPortal.
#----------------------------------------------------------------------------
#Examples
#ACCESSCODE=A605VBD4
#-------------------------------------------------------------------------------
ACCESSCODE=<yourAccesscodehere>
26 Suncorp Bank
Appendix BThissectioncontainsdetailedinformationonRESULTCODEsdisplayedbytheBatchLoaderapplication.
ERR BATCHLOADER (BatchLoader Configuration Errors)ERRBATCHLOADERerrormessagestypicallydepictconfigurationerrorsoftheapplication.WiththeexceptionofL000andL001,theseerrorswillpreventtheapplicationfromprocessingthebatchfile.
Info Description / Resolution
B000 CouldnotfindthePaymentClient.Pleasecheckthe“lax.class.path”settingintheLoad.laxfile,orcheckyourCLASSPATHenvironmentvariable.
B001 BATCHLOADER.propertiesconfigurationproblem
B002 Alockfileindicatesthattheapplicationisalreadyrunning.OnlyoneinstanceoftheBatchLoadercanrunatanyonetime.Thelockfilemayhavebeenleftbehindbyapreviouscrash.Ifyouare100%surenootherinstancesoftheBatchLoaderisrunning,youmayremovetheBATCHLOADER.lockfilefromthe“log”directoryandrestarttheapplication.
B003 Unabletocreate“.state”file.Pleasecheckthatthefilesin“batchout”arenotwriteprotected,andthatyouhaveread/writeaccesstothe“batchout”directory.
B004 Thereisaproblemwiththeselectedbatchfile.Pleasecheckthatthefileexists,andthatyouhavereadaccesstothefile,andthatitisasupportedbatchfiletype.
B005 Thereisaproblemwiththeselectedbatchfile.Pleasecheckthatthefileexists,andthatyouhavereadaccesstothefile,andthatitisasupportedbatchfiletype.
B006 Unabletocreate“.all.csv”file.Pleasecheckthatthefilesin“batchout”arenotwriteprotected,andthatyouhaveread/writeaccesstothe“batchout”directory.
B007 Unabletocreate“.app.csv”file.Pleasecheckthatthefilesin“batchout”arenotwriteprotected,andthatyouhaveread/writeaccesstothe“batchout”directory.
B008 Unabletocreate“.dec.csv”file.Pleasecheckthatthefilesin“batchout”arenotwriteprotected,andthatyouhaveread/writeaccesstothe“batchout”directory.
B009 Unabletocreate“.err.csv”file.Pleasecheckthatthefilesin“batchout”arenotwriteprotected,andthatyouhaveread/writeaccesstothe“batchout”directory.
L000 NoAMAusernamespecifiedforthismerchantID.ThisisreturnedintheRESULTCODEandRESULTINFOfieldduringvalidationorprocessing.PleaseconfiguretheappropriateMerchantID/username/passwordintheAMAConfigurationscreen.
L001 InvalidBATCHLOADER_DOFORMATspecifiedintheconfigurationfileBATCHLOADER.properties.ThisisreturnedintheRESULTCODEandRESULTINFOfieldduringvalidationorprocessing.Pleaseensurethatacorrectvaluehasbeenconfigured,andcloseandrestarttheapplication.
27Virtual POS Batch Loader Manual – August 2013
ERR RECORD (Batch File Record Errors)ERRRECORDerrormessagesindicateformattingerrorsinaparticulartransactionlineintheinputbatchfile.
Duringthe“ValidateOnly”cycle,validatedtransactionswillbemarkedas“VALIDATED”,otherwisethesuitableERRRECORDwillberecorded.
Duringthe“Processing”cycle,alltransactionsmarkedwithERRRECORDwillbestoppedbytheapplicationandwillnotbesent to the server.
Info Description / Resolution
R000 Blankline–indicatesablanklineinthebatchfile.
R010 InputTXNTYPEisinvalid.Checktheerrormessagefordetails.
R011 InputMERCHANTIDisinvalid.Checktheerrormessagefordetails.
R012 InputMERCHTXNREFisinvalid.Checktheerrormessagefordetails.
R013 InputCARDNUMisinvalid.Checktheerrormessagefordetails.
R014 InputCARDEXPisinvalid.Checktheerrormessagefordetails.
R015 InputCARDCSCisinvalid.Checktheerrormessagefordetails.
R016 InputAMOUNTisinvalid.Checktheerrormessagefordetails.
R017 InputORDERINFOisinvalid.Checktheerrormessagefordetails.
R018 InputTRANSACTIONNOisinvalid.Checktheerrormessagefordetails.
ERR PC (Payment Client Errors)ERRPCerrormessageswillonlyoccurduringthe“Processing”cycle.ERRPCmessagesindicatethattheformattingoftheparticulartransactionlinehasbeenvalidated,andhasbeenpassedtothePaymentClient,howeveranerrorhasoccurredatthePaymentClient.TypicalerrorsincludenonexistentMERCHANTIDs,internetconnectionerrors,amongstothers.
PleasecheckthePaymentClientdocumentationforafulllistingofPaymentClientErrors. APPROVED/DECLINED
TransactionsthathavesuccessfullyreachedtheauthorisationprocesswillhaveaRESULTCODEofAPPROVEDorDECLINED.
Resultcode Description
APPROVED Transactionhasgonethroughauthorisationandhasbeenapproved.
DECLINED Transactionhasgonethroughauthorisationandhasbeendeclined.
28 Suncorp Bank
Appendix CThissectioncontainsinformationontheinputfileformatssupportedbytheBatchLoaderapplication.
BATCHLINESTANDARDTheinputfileformatisspecifiedintheBATCHLOADER.propertiesconfigurationfile.Tousethe“BATCHLINESTANDARD”fileformat,thefollowingmustbeconfigured:
BATCHLOADER_DOFORMAT=BATCHLINESTANDARD
BATCHLINESTANDARD–Charge–InputFormat
# Input field Required Min Chars
Max Chars
Comments
1 TXNTYPE Y 1 1 Mustbe“C”forMOTOtransactions.
2 MERCHANTID Y 1 16 ProvidedmerchantID.
3 MERCHTXNREF N ~ 40 Merchantgenerateduniquereference.
4 CARDNUM Y 13 19Cardnumbertobecharged.BatchLoaderwilldoMOD10check.
5 CARDEXP Y 4 4 FormatYYMM.MMischeckedtobe<=12.
6 CARDCSC N ~ 4 CardSecurityCode(CVC2/CVV2).
7 AMOUNT Y 1 10 InCENTS(e.g.$1=100).Mustnotbe<=0.
8 ORDERINFO Y 1 34 Merchant generated reference.
29Virtual POS Batch Loader Manual – August 2013
# Output Field Comments
1 RESULTCODE Resultofthetransaction.
2 RESULTINFO Detailedinformationoftheresults.
3 TXNTYPE same as input
4 MERCHANTID same as input
5 MERCHTXNREF same as input
6 CARDNUM sameasinput(maybemaskedifconfigured).
7 CARDEXP same as input
8 CARDCSC always masked
9 AMOUNT same as input
10 ORDERINFO same as input
11 QSIRESPCODE ReceiptQSIResponseCode
12 QSIRESPCODEDESC ReceiptQSIResponseCodeDescription
13 AMOUNT ReceiptAuthorizedAmount
14 RECEIPTNO ReceiptReceiptNumber
15 ACQRESPCODE ReceiptAcquirerResponseCode
16 AUTHORIZEID ReceiptAuthorizationID
17 BATCHNO ReceiptSettlementBatchNumber
18 TRANSACTIONNO ReceiptShoppingTransactionNo
19 CARDTYPE ReceiptRecognizedCardType
*Note:errortransactions(thatarenotsenttotheserver)maynotcontainreceiptfields1119.
BATCHLINESTANDARD – Refund – Input Format
# Input field Required Min Chars
Max Chars
Comments
TXNTYPE Y 1 1 Mustbe“R”forrefundtransactions.
MERCHANTID Y 1 16 ProvidedmerchantID.
MERCHTXNREF N ~ 40 Merchantgenerateduniquereference.
TRANSACTIONNO Y 1 19 ShoppingTransactionNofromapreviousChargetransaction.
AMOUNT Y 1 34 InCENTS(e.g.$1=100).Mustnotbe<=0.
30 Suncorp Bank
BATCHLINESTANDARD – Refund – Output Format
# Output Field Comments
1 RESULTCODE Resultofthetransaction.
2 RESULTINFO Detailedinformationoftheresults.
3 TXNTYPE same as input
4 MERCHANTID same as input
5 MERCHTXNREF same as input
6 TRANSACTIONNO same as input
7 AMOUNT same as input
8 BLANK blankfield
9 BLANK blankfield
10 BLANK blankfield
11 QSIRESPCODE ReceiptQSIResponseCode
12 QSIRESPCODEDESC ReceiptQSIResponseCodeDescription
13 BLANK blankfield
14 RECEIPTNO ReceiptReceiptNumber
15 ACQRESPCODE ReceiptAcquirerResponseCode
16 AUTHORIZEID ReceiptAuthorizationID
17 BATCHNO ReceiptSettlementBatchNumber
18 TRANSACTIONNO ReceiptFinancialTransactionNo
19 BLANK blankfield
*Note:errortransactions(thatarenotsenttotheserver)maynotcontainreceiptfields1119.
BATCHLINESTANDARD – ExampleAsamplebatchfileissuppliedwiththeBatchLoader.ThefollowingisanexampleoftheBATCHLINESTANDARDchargeinput format.
C,TESTTESAUDALUCYF,MERCHTXNREF01,5123456789012346,0504,123,100,ORDERINFO01 C,TESTTESAUDALUCYF,MERCHTXNREF02,4005550000000001,0504,1234,100,ORDERINFO02 C,TESTTESAUDALUCYF,MERCHTXNREF03,5123456789012346,0504,123,100,ORDERINFO03