USAePay developer http://wiki.usaepay.com/ 2009-11-20T14:09:10-08:00 USAePay http://wiki.usaepay.com/ http://wiki.usaepay.com/lib/images/favicon.ico text/html 2009-10-22T15:34:53-08:00 developer:3rdparty http://wiki.usaepay.com/developer/3rdparty?rev=1256250893&do=diff These fully accessible 3rd party toolkits were written by USA ePay's merchants, partners and co-developers. If you have any questions or require support with them please contact the developer directly. USA ePay cannot take responsibility for your use of 3rd party toolkits. text/html 2009-04-06T11:30:49-08:00 developer:accessdb http://wiki.usaepay.com/developer/accessdb?rev=1239042649&do=diff Overview This document describes two example Access databases that use the USA ePay XCharge component with Access forms to perform transactions in the USA ePay gateway. One example database uses the Active-X Com component (.dll), and the other uses the Active-X control (.ocx) version of the XCharge component. text/html 2008-01-28T09:56:28-08:00 developer:asp http://wiki.usaepay.com/developer/asp?rev=1201542988&do=diff Please refer to the xCharge Control for ASP Server Side scripts. text/html 2008-01-10T13:04:49-08:00 developer:avs http://wiki.usaepay.com/developer/avs?rev=1199999089&do=diff Introduction TODO: write intro on avs Reference text/html 2008-02-29T08:03:13-08:00 developer:avsresultcodes http://wiki.usaepay.com/developer/avsresultcodes?rev=1204300993&do=diff The following is a list of result codes for the Address Verification System (AVS) and what each one indicates. The codes listed in the Code column are the most common responses, but depending on the platform being used, codes listed in the Alternates column may be received. text/html 2009-05-06T11:21:37-08:00 developer:cardlevelcodes http://wiki.usaepay.com/developer/cardlevelcodes?rev=1241634097&do=diff Code Description A Visa Traditional B Visa Traditional Rewards C Visa Signature D Visa Signature Preferred G Visa Business H Visa Consumer Check Card I Visa Commerce K Visa Corporate M MasterCard/EuroCard and Diners S Visa Purchasing U Visa TravelMoney G1 Visa Signature Business G2 Visa Business Check Card J1 Visa General Prepaid J2 Visa Prepaid Gift Card J3 Visa Prepaid Healthcare J4 Visa Prepaid Commercial K1 Visa GSA Co… text/html 2008-09-12T12:09:33-08:00 developer:cavv http://wiki.usaepay.com/developer/cavv?rev=1221246573&do=diff Get an extra layer of security when you shop online In addition to Visa's other ways of preventing, detecting, and resolving fraud, the company offers Verified by Visa, a free, simple-to-use service that confirms your identity with an extra password when you make an online transaction. text/html 2008-09-10T15:26:49-08:00 developer:cavvresultcodes http://wiki.usaepay.com/developer/cavvresultcodes?rev=1221085609&do=diff The following is a list of result codes for Verified by Visa and what each one indicates. The codes listed in the Code column are the most common responses, but depending on the platform being used some might not apply. Code Meaning 0 Failed validation – authentication 1 Failed validation – authentication 2 Passed validation – authentication 3 Passed validation – attempt (Authentication was attempted) 4 Failed validation – attempt (Authentication was attempted) 5 Reserved – not … text/html 2008-06-17T15:13:17-08:00 developer:clibrary http://wiki.usaepay.com/developer/clibrary?rev=1213740797&do=diff Description This program will read the input from an HTML form. After processing the form values, it will set up an SSL session to forward the values to the USA ePay gateway. Response from the gateway is then saved in a string variable resultStatus. Detailed descriptions and instructions can be found by going through the source code and reading the comments. text/html 2008-11-17T15:39:00-08:00 developer:coldfusion http://wiki.usaepay.com/developer/coldfusion?rev=1226965140&do=diff Download Download Coldfusion Library v1.3 (3.9KB) Example <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>Untitled</title> </head> <body> <!--- The following lines will send the coldFusion ePay module all the values that should be submitted to the gateway. You should manually change the value of CARDNUM to your own source key provided by USA ePay. As for the other variables, they should be assigned to your form variables collected from the u… text/html 2008-03-31T11:09:38-08:00 developer:comobject http://wiki.usaepay.com/developer/comobject?rev=1206986978&do=diff Download Download COM Object v1.2 (77KB) USAepay Gateway Wrapper COM This COM object will collect the USAePay Gateway API form variables and send them to the gateway via an SSL connection. The send function of the COM object accepts a pointer to an LPSTR, which it will then fill up with the resulting response from the gateway. text/html 2009-03-16T17:41:43-08:00 developer:currencycode http://wiki.usaepay.com/developer/currencycode?rev=1237250503&do=diff Currency Codes When processing an international transaction, the second non-domestic source key will be used. An extra field 'currency' is required. This field indicates currency of the transaction. The currency field must be set to the numerical code of the currency. If you are processing on a domestic (USD) account, a currency code is not required. The full ISO 4217 list is available here text/html 2008-04-29T08:56:39-08:00 developer:cvv2 http://wiki.usaepay.com/developer/cvv2?rev=1209484599&do=diff Introduction Card Verification Value (CVV) provides an additional level of online fraud protection. The card security codes are 3 or 4 digit codes printed or embossed on Visa, Mastercard, American Express and Discover cards. These codes are also referred to as CVV2, CVC, CSC or CCID. Their purpose is to provide additional protection against fraudulent card use. text/html 2008-03-11T10:53:23-08:00 developer:cvv2resultcodes http://wiki.usaepay.com/developer/cvv2resultcodes?rev=1205258003&do=diff The card security codes are 3 or 4 digit codes printed or embossed on Visa, Mastercard, American Express and Discover cards. These codes are also referred to as CVV2, CVC, CSC or CCID. Their purpose is to provide additional protection against fraudulent card use. Below is a list of possible result codes. text/html 2008-10-20T16:46:13-08:00 developer:delphi http://wiki.usaepay.com/developer/delphi?rev=1224546373&do=diff The USA ePay Gateway Wrapper is a Delphi VCL that provides an effortless way to connect your Delphi applications to the USA ePay gateway. Once installed the USA ePay tab will appear in the component palette and the TUSAepay object will be ready to use in your forms. text/html 2009-06-05T12:22:04-08:00 developer:dotnet http://wiki.usaepay.com/developer/dotnet?rev=1244229724&do=diff Platform Build File Size Link .NET v2.0 3377 USAePayAPI-3377.zip 58k Download .NET v1.0 2673 USAePayAPI-2692-dotnet1.zip 17k Download Installation To use this class in your Visual Studio project, follow these steps: text/html 2008-06-09T13:12:02-08:00 developer:errorcodes http://wiki.usaepay.com/developer/errorcodes?rev=1213042322&do=diff Error List in PDF Format Numeric Code Description Additional Information 00001 Password/Username Incorrect. Sent by login screen when the username and/or the password are incorrect.00002 Access to page denied. The user has attempted to access a page they don't have permission to access.00003 Transaction type [type] not supported. Please contact support. Is returned by /console/vterm.php when an unknown transaction type (sale, credit, etc) is attempted.00004 Processing gateway currently o… text/html 2008-01-07T17:18:11-08:00 developer:errormsg http://wiki.usaepay.com/developer/errormsg?rev=1199755091&do=diff Invalid Charge Amount - This is due to the amount not being in the correct format of 00.00 or UMamount is misspelled and it is case sensitive or UMcurrency is set to USD in an account that is already defaulted to USD. In this case DO NOT pass the UMcurrency field reference to the gateway. text/html 2009-01-09T12:15:19-08:00 developer:fieldlist http://wiki.usaepay.com/developer/fieldlist?rev=1231532119&do=diff DB Table Transaction API SOAP .NET PHP Receipt transid Row 1 Col 2 Row 1 Col 3 merchid some colspan (no user Row 2 Col 2 Row 2 Col 3 type Row 2 Col 2 Row 2 Col 3 created Row 2 Col 2 Row 2 Col 3 batchid Row 2 Col 2 Row 2… text/html 2008-11-17T15:41:25-08:00 developer:glossary http://wiki.usaepay.com/developer/glossary?rev=1226965285&do=diff This page is a handy reference for many of the terms and abbreviations used throughout these documents and the credit card processing industry. Access Control The process of ensuring that systems are only accessed by those authorized to do so, and only in a manner for which they have been authorized. text/html 2009-05-19T11:53:17-08:00 developer:guide http://wiki.usaepay.com/developer/guide?rev=1242759197&do=diff Introduction to Support Wiki The USAePay Wiki provides a wealth of documentation for developers, merchant and resellers wishing to integrate their website, pos application or third party software. * Developing a payment processing application is a careful and tedious task. Merchant Services requires cooperation of several different entities such as a Merchant Bank, a Merchant Service Provider, a Processing Platform, the issuing Credit Card company, a Merchant and their developer, and of c… text/html 2008-02-29T07:16:10-08:00 developer:hexadecimal_color_chart http://wiki.usaepay.com/developer/hexadecimal_color_chart?rev=1204298170&do=diff Below is a chart of colors and their corresponding hexadecimal codes for use in customizing your website and coordinating your USA ePay elements with the look and feel of your existing site. text/html 2009-07-03T10:36:57-08:00 developer:highavailability http://wiki.usaepay.com/developer/highavailability?rev=1246642617&do=diff Introduction USAePay provides a variety of tools and strategies to provide merchants with as close to 100% continuous processing of payments as possible. This guide provides developers with the background information and examples necessary to leverage these tools and maximize the availability of payment processing. text/html 2008-03-06T12:39:24-08:00 developer:java http://wiki.usaepay.com/developer/java?rev=1204835964&do=diff Examples How to calculate the MD5 hash The following packages need to be imported: import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.math.BigInteger; Example public String createMD5Hash (String token) { String s = token; MessageDigest m; String returnstring = null; try { m = MessageDigest.getInstance("MD5"); m.update(s.getBytes(),0,s.length()); returnstring = new BigInteger(1,m.digest()).toString(16); … text/html 2009-09-08T09:41:39-08:00 developer:javalibrary http://wiki.usaepay.com/developer/javalibrary?rev=1252428099&do=diff USAePay offers two java libraries (in Jar form) that provide an easy to use interface to our advanced soap API. One version of the library uses the JAX-WS library and the other uses the JAX-RPC library. Most users will want to pick the JAX-WS version unless they are in an older environment or can only support JAX-RPC. text/html 2008-01-28T09:50:00-08:00 developer:javascript http://wiki.usaepay.com/developer/javascript?rev=1201542600&do=diff USAePay JavaScript Instructions The javascript is ready to be used in any HTML form containing the gateway specific variable names. Add the following line to the head tag of your HTML form page and save the connect.js file to the same directory as your form. text/html 2008-02-26T09:42:41-08:00 developer:mobile http://wiki.usaepay.com/developer/mobile?rev=1204047761&do=diff Wireless ePay is a new, affordable option for merchants on the go. Wireless ePay works with any Java-based (J2ME) phone and allows merchants to process credit cards wirelessly while maintaining their low retail rates. What is Wireless ePay? Wireless ePay is a mobile solution for processing wireless transactions over any provider's wireless network. In the past, merchants who needed to process credit card sales in the field - whether it was at an open-air market or a networking conference - wo… text/html 2008-01-04T07:37:06-08:00 developer:multicurrency http://wiki.usaepay.com/developer/multicurrency?rev=1199461026&do=diff Most merchant accounts can process credit cards for customers in any country as long as all amounts are in the merchants native amount. For example a US merchant can accept an order on their website from a customer in Europe. In this case the order total would be in USD and the batch would be sent to the bank in USD. The customers card would handle the conversion to Euros and the customer would see the order amount in Euros on their credit card statement. While this process works, it is not… text/html 2009-09-25T14:26:39-08:00 developer:news http://wiki.usaepay.com/developer/news?rev=1253913999&do=diff Communication between USAePay and external developers is a critical component of integration. This section includes RSS news feeds and email subscriptions for the USAePay development group, to keep developers up to date on all of the updates and new features that we add on a regular and ongoing basis. While we make every effort to maintain backwards compatibility, changes can occasionally have a negative impact on merchant software. text/html 2009-01-29T12:18:44-08:00 developer:perl http://wiki.usaepay.com/developer/perl?rev=1233260324&do=diff Simple Example Using LWP Module Make sure to replace the UMkey parameter with your source key. Also, the example below uses our sandbox test server. Make sure to change the url to <https://secure.usaepay.com/gate> when ready to process production transactions text/html 2009-08-19T11:06:32-08:00 developer:phplibrary http://wiki.usaepay.com/developer/phplibrary?rev=1250705192&do=diff Downloads Platform File Download UNIX (Linux, BSD, Mac OS X, etc) usaepay-php-1.6.0.tgz Download Windows usaepay-php-160.zip Download PHP Library file only (usaepay.php) usaepay-php-160.txt Download Library Overview The USAePay PHP Library provides an easy to use PHP interface for running server to server processing. If you are developing your site using PHP it is highly recommended that you use this script rather than the client side method. Not only will it provide a more consi… text/html 2008-01-10T08:13:32-08:00 developer:reference http://wiki.usaepay.com/developer/reference?rev=1199981612&do=diff Credit Card Numbers for Testing The following list of test credit card numbers maybe used either on the Test Bed or in Test Mode. The use of live credit card information in a test environment is strongly discourage. It is recommended that the card numbers on this page be used instead. text/html 2009-01-29T09:47:21-08:00 developer:sandbox http://wiki.usaepay.com/developer/sandbox?rev=1233251241&do=diff The sandbox provides a full simulation of the production gateway and is the ideal way to test your integration. Requesting a Sandbox Account Going Live: Moving from Sandbox to Production Test Credit Card Numbers Test Check ACH Data text/html 2009-07-02T10:32:28-08:00 developer:soap http://wiki.usaepay.com/developer/soap?rev=1246555948&do=diff text/html 2008-04-11T10:58:51-08:00 developer:status http://wiki.usaepay.com/developer/status?rev=1207936731&do=diff This page allows you to monitor the availability of the USAePay gateway network. In addition to the primary url we provide alternate urls that allow you to access one of our secondary datacenters. For more information on designing automatic failover capabilities in your solution please visit the Redundancy Howto. text/html 2009-05-11T13:26:08-08:00 developer:statuscodes http://wiki.usaepay.com/developer/statuscodes?rev=1242073568&do=diff The transaction status codes are used to indicate where in the transaction life cycle a transaction is. These codes can be used when searching on the status field. Codes Code Label Meaning N Queued New Transaction (hasn't been processed yet) P Pending For credit cards, batch hasn't closed yet. For checks, hasn't been sent to Bank yet. B Submitted For checks, sent to bank and void no longer available. F Funded Funded (for checks, the date that the money left the account. S S… text/html 2009-09-08T11:15:34-08:00 developer:support http://wiki.usaepay.com/developer/support?rev=1252433734&do=diff USA ePay's Developer Library contains documentation, examples, source code and controls for integrating our gateway into your software. If you can't find what you're looking for please try the 3rd Party Tools or email us at <devsupport@usaepay.com> text/html 2009-09-18T11:07:29-08:00 developer:testcards http://wiki.usaepay.com/developer/testcards?rev=1253297249&do=diff The following list of test credit card numbers maybe used either on the Test Account or in Test Mode. The use of live credit card information in a test environment is strongly discourage. It is recommended that the card numbers on this page be used instead. text/html 2008-03-18T08:37:59-08:00 developer:testcheckdata http://wiki.usaepay.com/developer/testcheckdata?rev=1205854679&do=diff The following list of test check information is made available for testing check processing functionality on our Sandbox system. The account data should not be used in production. Routing Account Amount Response Reason 987654321 Any Any Error Invalid routing Number Any Any 5.99 Decline Returned check for this account Any Any 9999.99 ManagerApproval Warning: You have exceeded your allocated monthly transaction volume * Any other combination of 9 digit routing number and accoun… text/html 2009-08-02T10:36:16-08:00 developer:testmode http://wiki.usaepay.com/developer/testmode?rev=1249234576&do=diff Introduction Test mode is a flag that provides limited ability for a merchant to try a sale without actually running a transaction. We do not recommended that developers use this feature for in-depth testing as it does not accurately simulate a production transaction. Developers interested in testing their software in a pre-production environment should instead use the Sandbox. text/html 2009-08-06T11:07:07-08:00 developer:transactionapi http://wiki.usaepay.com/developer/transactionapi?rev=1249582027&do=diff Production / Live URLs to connect to: <https://www.usaepay.com/gate> <https://www.usaepay.com/secure/gate> Port: 443 - HTTPS API Overview The gateway API can be accessed in two ways, server-side or client-side, depending on the capabilities of your scripting/cgi platform. The server-side method is safer but requires that your CGI make an SSL connection to the CGI in the background. text/html 2008-02-04T07:46:06-08:00 developer:vpas_msc http://wiki.usaepay.com/developer/vpas_msc?rev=1202139966&do=diff The gateway supports VPAS (Verified by Visa) and UCAF (Mastercard Securecode) with both an integrated authentication system and support for third party verification. Using the integrated system provides a quick, easy method for developers to support Verified by Visa and Mastercard Secure Code without requiring complicated XML messaging formats. text/html 2009-10-09T09:50:55-08:00 developer:xcharge http://wiki.usaepay.com/developer/xcharge?rev=1255107055&do=diff Download Download xCharge2120.zip (2.28MB) Component Overview The USA ePay XCharge installation package includes both an Active-X (.dll) COM component and Active-X COM (.ocx) control version of the XCharge transaction component. Both have identical properties and methods.