Two Concourse Parkway, Suite 800, Atlanta, GA 30328 © Elavon, Incorporated 2014
Two Concourse Parkway, Suite 800, Atlanta, GA 30328 © Elavon, Incorporated 2014. All Rights Reserved Developer Guide VirtualMerchant Developer Guide Document #VRM-0002-D © Elavon, Incorporated 2013. All Rights Reserved Page 2 of 289 Copyright Copyright © 2014 Elavon, Incorporated. All rights reserved. No part of this publication may be reproduced or distributed without the prior consent of Elavon, Inc., Two Concourse Parkway, Suite 800, Atlanta, GA 30328 Disclaimer Elavon, Inc., provides this publication as is without warranty of any kind, either expressed or implied. This publication could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein. These changes will be incorporated in new editions of the publication. Elavon, Inc. may make improvements and/or changes in the product(s) and/or program(s) described in this publication at any time. Trademarks VirtualMerchant is a registered trademark of Elavon, Inc. All other brand and product names are trademarks or registered trademarks of their respective companies. Related Documents VirtualMerchant Getting Started Guide VirtualMerchant System Administration Guide VirtualMerchant Transaction Processing Guide Typographical Conventions Throughout this user guide you will see words and phrases that appear in different fonts and formats. The following table describes the typographical conventions used in this user guide. Item Convention Example Notes containing important information Denoted by a change in font and possibly color. bold Note: This is an example. Reference document titles Bold italics Batch Management tasks are covered in a separate document, the Batch Management User Guide. Sample Code Fixed-width font (Courier New) Sample Code 123 45 Typed Commands Fixed-width font (Courier New). bold Type cd \Elavon\pbase in a command window. VirtualMerchant Developer Guide Document #VRM-0002-D © Elavon, Incorporated 2014. All Rights Reserved Page 3 of 289 Table of Contents Introduction.............................................................................................................................................. 6 Chapter 1 VirtualMerchant Features .......................................................................................................................................... 6 API Overview............................................................................................................................................................ 7 Implementation Guidelines ....................................................................................................................................... 8 Integration Checklist ................................................................................................................................................. 9 Getting Started ....................................................................................................................................... 10 Chapter 2 Getting a Unique Test Account ............................................................................................................................... 10 URLS ...................................................................................................................................................................... 11 Demo URLS ....................................................................................................................................................... 11 Production URLS ................................................................................................................................................ 11 Communicating with VirtualMerchant.................................................................................................................... 11 Authentication ......................................................................................................................................................... 12 Payment Forms........................................................................................................................................................ 13 Merchant Payment Form ..................................................................................................................................... 13 VirtualMerchant Payment Form ......................................................................................................................... 16 Receipt Forms ......................................................................................................................................................... 19 Merchant Receipt ................................................................................................................................................ 20 VirtualMerchant Receipt ..................................................................................................................................... 21 Export Scripts ..................................................................................................................................................... 23 Transaction Security .............................................................................................................................. 26 Chapter 3 Common Fraudulent Activities ............................................................................................................................... 26 Best Practices and Compliance Checklist ............................................................................................................... 27 PCI DSS Guidelines ................................................................................................................................................ 30 External Security Resources .................................................................................................................................... 32 Transaction Format ................................................................................................................................ 34 Chapter 4 Credit Card Transactions ......................................................................................................................................... 35 Credit Card Sale (ccsale) ................................................................................................................................ 37 Credit Card Auth Only (ccauthonly) ............................................................................................................ 58 Credit Card AVS Only (ccavsonly) ............................................................................................................... 67 Credit Card Verification (ccverify) ............................................................................................................... 71 Credit Card Return/Credit (cccredit) ............................................................................................................ 76 Credit Card Force (ccforce) ........................................................................................................................... 81 Credit Card Balance Inquiry (ccbalinquiry) ............................................................................................... 87 VirtualMerchant Developer Guide Document #VRM-0002-D © Elavon, Incorporated 2014. All Rights Reserved Page 4 of 289 Credit Card Return (ccreturn) ....................................................................................................................... 89 Credit Card Void (ccvoid) ............................................................................................................................... 91 Credit Card Completion (cccomplete) .......................................................................................................... 95 Credit Card Delete (ccdelete) ........................................................................................................................ 99 Credit Card Update Tip (ccupdatetip) ....................................................................................................... 100 Credit Card Signature (ccsignature) .......................................................................................................... 104 Recurring Transactions ......................................................................................................................................... 107 Add Recurring Transaction (ccaddrecurring) .......................................................................................... 107 Update Recurring Transaction (ccupdaterecurring) .............................................................................. 114 Delete Recurring Transaction (ccdeleterecurring) ............................................................................... 118 Submit Recurring Payment (ccrecurringsale) ........................................................................................ 120 Installment Transactions ....................................................................................................................................... 122 Add Installment Transactions (ccaddinstall) ........................................................................................... 122 Update Installment Transactions (ccupdateinstall) ............................................................................... 129 Delete Installment Transactions (ccdeleteinstall) ................................................................................ 133 Submit Installment Payment (ccinstallsale) .......................................................................................... 134 Batch Import Transactions .................................................................................................................................... 136 Credit Batch Import (ccimport) .................................................................................................................... 137 Recurring Batch Import (ccrecimport) ...................................................................................................... 144 Debit Card Transactions ........................................................................................................................................ 151 Debit Purchase (dbpurchase) ....................................................................................................................... 151 Debit Return (dbreturn) ............................................................................................................................... 154 Debit Inquiry (dbbainquiry) ....................................................................................................................... 156 EBT Transactions .................................................................................................................................................. 158 Food Stamp Purchase (fspurchase) ............................................................................................................ 158 Food Stamp Return (fsreturn) .................................................................................................................... 160 Food Stamp Inquiry (fsbainquiry) ............................................................................................................ 162 Food Stamp Force Purchase (fsforcepurchase) ...................................................................................... 164 Food Stamp Force Return (fsforcereturn)............................................................................................... 166 Cash Benefit Purchase (cbpurchase) ........................................................................................................... 168 Cash Benefit Inquiry (cbbainquiry) ........................................................................................................... 170 Gift Card Transactions .......................................................................................................................................... 172 Gift Card Activation (egcactivation) ....................................................................................................... 172 Gift Card Sale/Redemption (egcsale) .......................................................................................................... 174 Gift Card Refund (egccardrefund) ............................................................................................................ 177 Gift Card Replenishment/Reload (egcreload) ............................................................................................. 179 Gift Card Balance Inquiry (egcbalinquiry) .............................................................................................. 181 Gift Card Credit (egccredit) ....................................................................................................................... 183 VirtualMerchant Developer Guide Document #VRM-0002-D © Elavon, Incorporated 2014. All Rights Reserved Page 5 of 289 Electronic Check Transactions .............................................................................................................................. 185 Electronic Check Purchase (ecspurchase) .................................................................................................. 185 Electronic Check Void (ecsvoid) .................................................................................................................. 188 PINLess Debit Transactions .................................................................................................................................. 190 PINLess Debit Purchase (pldpurchase) ...................................................................................................... 190 Cash Tender Transactions ..................................................................................................................................... 192 Cash Sale (cashsale) .................................................................................................................................... 192 Cash Return/Credit (cashcredit) ................................................................................................................ 195 Query/Search Transactions ................................................................................................................................... 197 Transaction Query (txnquery) ...................................................................................................................... 197 Batch Settlement ................................................................................................................................................... 205 Settle Transaction (settle) ............................................................................................................................ 205 Integration Reference ........................................................................................................................... 209 Chapter 5 Supported Transaction Input Fields ...................................................................................................................... 209 Fraud Prevention Matrix ....................................................................................................................................... 223 ISO Country Codes ............................................................................................................................................... 225 ISO Currency Codes.............................................................................................................................................. 229 Additional Processing Options ............................................................................................................ 231 Chapter 6 3D Secure Transactions ......................................................................................................................................... 231 Transaction Flow .............................................................................................................................................. 232 Transaction Flow process.do ................................................................................................................. 232 Transaction Flow processxml.do .......................................................................................................... 233 Transaction Examples ....................................................................................................................................... 240 Dynamic Currency Conversion (DCC) Transactions ............................................................................................ 247 Transaction Flow .............................................................................................................................................. 247 Transaction Examples ....................................................................................................................................... 248 Receipt Requirements ....................................................................................................................................... 254 Authorization Response Codes ............................................................................................................ 256 Chapter 7 Credit Card Response Codes ................................................................................................................................. 256 Electronic Gift Card (EGC) Response Codes ....................................................................................................... 258 AVS Response Codes............................................................................................................................................ 259 CVV2/CVC2 Response Codes .............................................................................................................................. 259 Error Codes ........................................................................................................................................................... 260 Code Samples ...................................................................................................................................... 268 Chapter 8 Perl Sample ........................................................................................................................................................... 268 PHP Sample .......................................................................................................................................................... 269 Python Sample ...................................................................................................................................................... 275 HTML Sample ...................................................................................................................................................... 276 Glossary ..................................................................................................................................................................... 287 VirtualMerchant Developer Guide Document #VRM-0002-D Glossary © Elavon, Incorporated 2013. All Rights Reserved Page 6 of 289 Introduction Chapter 1 The VirtualMerchant application is a secure, server-based system that supports transaction processing (authorization and settlement) in real-time. The VirtualMerchant API uses a pseudo-XML or name/value pairs implementation. You can submit transactions to the VirtualMerchant application using one of the following methods: • Virtual Terminal (VirtualMerchant Web interface or VirtualMerchant Mobile application) • VirtualMerchant API through the use of an integrated application This guide provides the information necessary to complete a successful VirtualMerchant integration including: • Transaction security • Processing filters • Payment integration • Transaction reference • Supported transaction input fields • Authorization response codes • Error codes • ISO country codes VirtualMerchant Features The Virtual Terminal enables you to use a standard Web browser to process transactions as a cost- effective payment solution. Using this application, you can: • Manage your payment account • Submit transactions • Monitor and review unsettled transactions • Search for and view settled transactions • Configure account settings For help with the Merchant Interface features and settings, refer to the VirtualMerchant User Guide. VirtualMerchant Developer Guide Document #VRM-0002-D © Elavon, Incorporated 2014. All Rights Reserved Page 7 of 289 API Overview The VirtualMerchant API enables you to write a point-of-sale application (website, software application, shopping cart, and so on) that interfaces with the VirtualMerchant payment gateway to process the following: • Full range of payment types including: • Credit card • Debit card • Food stamp • Cash benefit • Electronic check • Gift card • Cash tender • Recurring and installment transactions • Batch file transactions (a group of individual transaction requests combined into a file and sent in a single request) • Admin transactions (including settlement and search) The integration to the VirtualMerchant gateway supports transactions for both card present and non- present environments, including the following market segments: • E-Commerce • Mail order • Retail • Service Typically, customers use a variety of methods to integrate to the VirtualMerchant gateway. For example, you could: • Submit as little as four pieces of data from your application. By using the settings that have been configured in the VirtualMerchant administration section, you can gather the rest of the necessary information directly from the customer. • Use VirtualMerchant as a backend feature to your integrated application, completely transparent to your customers. You can write the process that gathers all of the pertinent customer information and the receipt page that displays the outcome of the transaction processing to the user. Most merchants fall somewhere in the middle of these scenarios. This combination of methods involves gathering some data from the customer before referring them to the VirtualMerchant application. This application gathers more information from them and displays the receipt after the transaction has been approved. This guide focuses on the processes and settings available to you to integrate to the VirtualMerchant payment gateway. VirtualMerchant Developer Guide Document #VRM-0002-D © Elavon, Incorporated 2014. All Rights Reserved Page 8 of 289 Implementation Guidelines To summarize the contents covered in this integration guide, keep in mind a few facts about VirtualMerchant: • VirtualMerchant is an application that resides on a Web server and will act as such. As long as you are following RFC 2818 with your requests, as well as sending the designated XML or key/value pairs, VirtualMerchant will respond as defined. • Processing using VirtualMerchant is language agnostic, provided your chosen language supports post over HTTPS. • Choose the integration type that makes sense for your programming capabilities and business needs, for instance a website that wants to have VirtualMerchant collect the information uploads/Finance/ developer-guide 10 .pdf
Documents similaires
![](https://b3c3.c12.e2-4.dev/disserty/uploads/preview/0apTxEFMyj2L1FJCl1LTpVFBcSMCufsH7Uy9s4F4e684wOgQ1FV3uVxCNg4Ido4jV9nFUSS78MqoedFYfunyo9qr.png)
![](https://b3c3.c12.e2-4.dev/disserty/uploads/preview/1xWBtb0gfPJDvPLEEaDSXb4QCw72rYd3MCwEPWuqarBTuuDHTd5hlbzGAzgHiVsCjPVEb5ZqEVWaBpJgJNFkMifo.png)
![](https://b3c3.c12.e2-4.dev/disserty/uploads/preview/bc46tVvLg1ejBUwCOmXjH45RE49nKx1ufrMwfVDTObZjxjLP7T2RzGY9W062jNsEHA3Daran5Y53RgSl31fh6oXF.png)
![](https://b3c3.c12.e2-4.dev/disserty/uploads/preview/AqaR76iCGZvfnX5zztFj87PBRDckH2KMNnWgyKw7tk2Nk68UH9g4E0NCtXyK0eSM24gKHWfPooo5Pp9OlQDcuHsy.png)
![](https://b3c3.c12.e2-4.dev/disserty/uploads/preview/w0Xo6lDLIag7FYpvS3EceSYw8ZxiJdUbKDH8F3V6cx0wo9fujMbcT80TDeQvRU4nvuuXgpfIXlQd3BfNm2hKyZ2t.png)
![](https://b3c3.c12.e2-4.dev/disserty/uploads/preview/UAvf3Q4SmQ8BSZL1ym42AfCUUkP5IgqEi3uJIyvICLv4Mm2XEB8CddNgVns920I7gNRGVQxNf8jZU3ObFoQ4E5d3.png)
![](https://b3c3.c12.e2-4.dev/disserty/uploads/preview/hfCuP3rXvD4GMw1jn4qM7EZfQPFtPOtfG81OtGMlCDHgtBha08Ngg3qwKAcVkU2aKRtjAULmU8mEcG2A8xycBzWh.png)
-
15
-
0
-
0
Licence et utilisation
Gratuit pour un usage personnel Attribution requise- Détails
- Publié le Jan 20, 2022
- Catégorie Business / Finance
- Langue French
- Taille du fichier 3.5955MB