XCharge Component v2.12.0

Download xCharge2120.zip (2.28MB)

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.

IMPORTANT NOTE: For ASP & ASP.NET projects you MUST use the .dll component version, using the control version may lead to IIS server instability.

There are ASP, ASP.NET, Access, VB, VB.NET, C#, and C++ examples for the .dll component version.

There are Access, VB, VB.NET, C#, and C++ examples for the .ocx control version.

Some may find the control version easier to use for desktop applications. The choice is yours.

The USA ePay XCharge component provides an easy to use Active-X COM interface for running server to server processing. If you are developing your site using ASP or using Visual Basic applications to process your transactions then it is highly recommended that you use this component rather than the client side method. Not only will it provide a more consistent interface to your customers, but it will also prevent manipulation of order data.

When using an ASP script, the basic flow will go something like:

1. Customer enters credit card data on merchant's server
2. Script on merchants server takes customer data and populates the required properties of USAePay XCharge Component
3. Merchant's server tells USAePay transaction to process (Process method)
4. XCharge component sends transaction via SSL encrypted HTTP connection to USAePay for authorization
5. XCharge component reads response from USAePay
6. XCharge component populates response properties
7. Merchant's script interprets the results and displays the corresponding response to the customer

You will need a Windows NT, 2000, XP, 2003 or 2008 system to use this component. The installation program should install any needed dependencies. On Windows 2008, you have to place the files in an alternate folder and register them from that folder using the command line. Placing the DLLs in the %System%/System32 folder won’t work.

To compile the VB samples you must have Microsoft Visual Basic 6.0.

To compile the C++ samples you must have Microsoft Visual C++ 6.0 or higher.

The C# samples require Microsoft Visual C# 2003 or Microsoft Visual Studio .NET 2003.

The VB.NET samples require Microsoft Visual VB.NET 2003 or Microsoft Visual Studio .NET 2003.

The ASP.NET Visual Studio .NET 2003 samples require Microsoft Visual Studio .NET 2003 and IIS 4.0 or higher.

The ASP.NET Web Matrix samples require Web Matrix and version 1.1 of the Microsoft .NET Framework installed.

The ASP.NET aspx samples require IIS 4.0 or higher and version 1.1 of the Microsoft .NET Framework installed.

The Access samples require Microsoft Access 2000 or higher.

(primarily used in conjunction with client-side with simple redirection) To enable merchant receipts for the component you must edit the source you are using. This is done by logging into www.usaepay.com. Click on “Settings”. Edit your source by clicking on the pencil next to its name. Enter your email address into the Merchant Receipt box. You may enter several email addresses separated by commas.

The most common transaction is a Sale. The customer's card will be authorized for the amount specified and placed in the batch for settlement. Once the batch is settled, the funds will be transferred to the merchant's account.

Please note: unless the merchant has configured their batch to auto close, they will need to log into usaepay.com to close their batch.

 
<!-- The following include statement tells ASP to include our file --> 
<!-- of const values. The include file can be found in the ASP --> 
<!-- examples directory. This allows us to use named variables -->
<!-- instead of numbers for our enumerated properties -->
<!-- (ResponseStatus, RecurringSchedule, and Command). -->
 
<!-- (i.e. "XCharge1.Command = sale" instead of "XCharge1.Command = 0") -->
 
<!-- #include virtual="xcenums.inc" -->      
 
<%                     
    Set XCharge1 = Server.CreateObject("USAePayXChargeCom2.XChargeCom2")
 
    XCharge1.Command = sale
 
    XCharge1.Sourcekey = "Ju0e3By6Vb5z9B2oAJUD2v40ADf4qhc5"            
 
    'This allows fraud blocking on the customers IP address    
    XCharge1.IP = Request.ServerVariables("REMOTE_ADDR") 
 
    XCharge1.Testmode = True                'Change this to False for the transaction 
                                            'to process
 
    XCharge1.Card = "4005562233445564"      'Card number, no dashes, no spaces        
    XCharge1.Exp = "0408"                   'Expiration date 4 digits
    XCharge1.Amount = "1.00"                'Charge amount in dollars        
    XCharge1.Invoice = "1234"               'Invoice number.  must be unique.        
    XCharge1.TransHolderName = "Max Powers" 'Name of card holder           
    XCharge1.Street = "456 Sunny Lane"      'Street address        
    XCharge1.Zip = "95130"                  'Zip code        
    XCharge1.Description = "Online Order"   'Description of charge        
    XCharge1.CVV2="435"                     'CVV2 code
 
    Response.Write "<H1>Please wait one moment while we process your card...</H1><BR>"
    Response.Flush 
 
    XCharge1.Process
 
    If XCharge1.ErrorExists = True Then            
        Dim XError
 
        Response.Write "<B><FONT COLOR=red>ERRORS:</FONT></B><BR>"
 
        For Each XError In XCharge1.Errors
            Response.Write "<B>Error Code:</B> " & XError.ErrorCode  
            Response.Write " <B>Error Text:</B> " & XError.ErrorText & " <BR>"
        Next
    End If
 
    Response.Write "<BR>"        
    Response.Write "<CENTER><TABLE BORDER=1>"
 
    Response.Write "<TR><TD COLSPAN=2><CENTER><B>"
    Response.Write "Transaction Results:"
    Response.Write "</B></CENTER></TD></TR>"
 
    Dim strResponseStatus
 
    Select Case XCharge1.ResponseStatus
            Case Approved
               strResponseStatus = "Approved"
            Case Declined                
               strResponseStatus = "Declined"
            Case Verification
               strResponseStatus = "Verification"                
            Case Error
              strResponseStatus = "Error"
    End Select
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Status: </FONT></B></TD>"
    Response.Write "<TD>" & strResponseStatus  & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Authorization Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAuthCode  & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Reference Number: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseReferenceNum & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Batch Reference #: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseBatch & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>AVS Result: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAVS & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>AVS Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAVSCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>CVV2 Result: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCVV2 & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>CVV2 Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCVV2Code & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>VPAS Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseVPASCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Result Test: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseResult & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Response Error: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseError & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Response Error Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseErrorCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>ACS URL: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseACSURL & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Payload: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponsePayload & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Is Duplicate: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseIsDuplicate & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Converted Amount: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConvertedAmount & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Converted Amount Currency: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConvertedAmountCurrency & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Conversion Rate: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConversionRate & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Customer Number: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCustNum & "</TD></TR>"     
 
    Response.Write "</TABLE></CENTER>"                       
 
    ' Clear the component instance from memory    
    set XCharge1 = Nothing
 
%>

The Auth Only transaction is extremely useful for companies that do not ship their products right away. The component will authorize the charge but instead of putting the charge into the merchant's batch, the charge is placed on the Queued Transactions screen. The merchant then has up to 30 days (depending on their bank) to “capture” the transaction. This allows a merchant to verify that the customer's card is good and that they have the funds available. The merchant then captures the charge once they have shipped the merchandise. There are two ways in which the transaction can be moved from the queued transactions screen to the current batch: 1) the merchant can log into www.usaepay.com and go to the queued transactions screen and select capture; 2) the transaction can be captured via the component. If you are planning on capturing the transaction via the component, make sure to record the value of the ResponseReferenceNum property. (See Capture Example)

 
<!-- The following include statement tells ASP to include our file --> 
<!-- of const values. The include file can be found in the ASP --> 
<!-- examples directory. This allows us to use named variables -->
<!-- instead of numbers for our enumerated properties -->
<!-- (ResponseStatus, RecurringSchedule, and Command). -->
 
<!-- (i.e. "XCharge1.Command = sale" instead of "XCharge1.Command = 0") -->
 
<!-- #include virtual="xcenums.inc" -->      
 
<%                     
    Set XCharge1 = Server.CreateObject("USAePayXChargeCom2.XChargeCom2")
 
    XCharge1.Command = authonly 'This tells the server to queue the transaction after 
                                'authorizing it.
 
    XCharge1.Sourcekey = "Ju0e3By6Vb5z9B2oAJUD2v40ADf4qhc5"            
 
    'This allows fraud blocking on the customers IP address    
    XCharge1.IP = Request.ServerVariables("REMOTE_ADDR") 
 
    XCharge1.Testmode = True                'Change this to False for the transaction 
                                            'to process
 
    XCharge1.Card = "4005562233445564"      'Card number, no dashes, no spaces        
    XCharge1.Exp = "0408"                   'Expiration date 4 digits
    XCharge1.Amount = "1.00"                'Charge amount in dollars        
    XCharge1.Invoice = "1234"               'Invoice number.  must be unique.        
    XCharge1.TransHolderName = "Max Powers" 'Name of card holder           
    XCharge1.Street = "456 Sunny Lane"      'Street address        
    XCharge1.Zip = "95130"                  'Zip code        
    XCharge1.Description = "Online Order"   'Description of charge        
    XCharge1.CVV2="435"                     'CVV2 code
 
    Response.Write "<H1>Please wait one moment while we process your card...</H1><BR>"
    Response.Flush 
 
    XCharge1.Process
 
    If XCharge1.ErrorExists = True Then            
        Dim XError
 
        Response.Write "<B><FONT COLOR=red>ERRORS:</FONT></B><BR>"
 
        For Each XError In XCharge1.Errors
            Response.Write "<B>Error Code:</B> " & XError.ErrorCode  
            Response.Write " <B>Error Text:</B> " & XError.ErrorText & " <BR>"
        Next
    End If
 
    Response.Write "<BR>"        
    Response.Write "<CENTER><TABLE BORDER=1>"
 
    Response.Write "<TR><TD COLSPAN=2><CENTER><B>"
    Response.Write "Transaction Results:"
    Response.Write "</B></CENTER></TD></TR>"
 
    Dim strResponseStatus
 
    Select Case XCharge1.ResponseStatus
            Case Approved
               strResponseStatus = "Approved"
            Case Declined                
               strResponseStatus = "Declined"
            Case Verification
               strResponseStatus = "Verification"                
            Case Error
              strResponseStatus = "Error"
    End Select
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Status: </FONT></B></TD>"
    Response.Write "<TD>" & strResponseStatus  & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Authorization Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAuthCode  & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Reference Number: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseReferenceNum & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Batch Reference #: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseBatch & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>AVS Result: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAVS & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>AVS Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAVSCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>CVV2 Result: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCVV2 & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>CVV2 Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCVV2Code & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>VPAS Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseVPASCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Result Test: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseResult & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Response Error: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseError & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Response Error Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseErrorCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>ACS URL: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseACSURL & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Payload: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponsePayload & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Is Duplicate: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseIsDuplicate & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Converted Amount: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConvertedAmount & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Converted Amount Currency: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConvertedAmountCurrency & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Conversion Rate: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConversionRate & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Customer Number: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCustNum & "</TD></TR>"
 
    Response.Write "</TABLE></CENTER>"                       
 
    ' Clear the component instance from memory    
    set XCharge1 = Nothing
 
%>

This command allows you to capture a previously authorized charge. A practical example of this would be a shopping cart that implements an order management system. When a customer places an order the transaction is authorized and then queued. The merchant logs into the shopping cart and moves the order to “Shipped”. The shopping cart would then tell USAePay to capture that transaction. To capture the transaction via the component, you must have the value of the ResponseReferenceNum property returned during the original authorization. This value should be stored on the merchant's server.

 
<!-- The following include statement tells ASP to include our file --> 
<!-- of const values. The include file can be found in the ASP --> 
<!-- examples directory. This allows us to use named variables -->
<!-- instead of numbers for our enumerated properties -->
<!-- (ResponseStatus, RecurringSchedule, and Command). -->
 
<!-- (i.e. "XCharge1.Command = sale" instead of "XCharge1.Command = 0") -->
 
<!-- #include virtual="xcenums.inc" -->      
 
<%                     
    Set XCharge1 = Server.CreateObject("USAePayXChargeCom2.XChargeCom2")
 
    XCharge1.Command = capture 
 
    XCharge1.Sourcekey = "Ju0e3By6Vb5z9B2oAJUD2v40ADf4qhc5"            
 
    'This allows fraud blocking on the customers IP address    
    XCharge1.IP = Request.ServerVariables("REMOTE_ADDR") 
 
    XCharge1.Testmode = True                'Change this to False for the transaction 
                                            'to process
 
    XCharge1.RefNum = "MyResponseRefNum"    'This is where you would put the value of 
                                            'the ResponseReferenceNum property from a 
                                            'previous transaction.
 
    Response.Write "<H1>Please wait one moment while we capture the charge...</H1><BR>"
    Response.Flush 
 
    XCharge1.Process
 
    If XCharge1.ErrorExists = True Then            
        Dim XError
 
        Response.Write "<B><FONT COLOR=red>ERRORS:</FONT></B><BR>"
 
        For Each XError In XCharge1.Errors
            Response.Write "<B>Error Code:</B> " & XError.ErrorCode  
            Response.Write " <B>Error Text:</B> " & XError.ErrorText & " <BR>"
        Next
    End If
 
    Response.Write "<BR>"        
    Response.Write "<CENTER><TABLE BORDER=1>"
 
    Response.Write "<TR><TD COLSPAN=2><CENTER><B>"
    Response.Write "Transaction Results:"
    Response.Write "</B></CENTER></TD></TR>"
 
    Dim strResponseStatus
 
    Select Case XCharge1.ResponseStatus
            Case Approved
               strResponseStatus = "Approved"
            Case Declined                
               strResponseStatus = "Declined"
            Case Verification
               strResponseStatus = "Verification"                
            Case Error
              strResponseStatus = "Error"
    End Select
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Status: </FONT></B></TD>"
    Response.Write "<TD>" & strResponseStatus  & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Authorization Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAuthCode  & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Reference Number: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseReferenceNum & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Batch Reference #: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseBatch & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>AVS Result: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAVS & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>AVS Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseAVSCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>CVV2 Result: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCVV2 & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>CVV2 Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCVV2Code & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>VPAS Result Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseVPASCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Result Test: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseResult & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Response Error: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseError & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Response Error Code: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseErrorCode & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>ACS URL: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseACSURL & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Payload: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponsePayload & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Is Duplicate: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseIsDuplicate & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Converted Amount: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConvertedAmount & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Converted Amount Currency: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConvertedAmountCurrency & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Conversion Rate: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseConversionRate & "</TD></TR>"
 
    Response.Write "<TR><TD><B><FONT COLOR=green>Customer Number: </FONT></B></TD>"
    Response.Write "<TD>" & XCharge1.ResponseCustNum & "</TD></TR>"
 
    Response.Write "</TABLE></CENTER>"                       
 
    ' Clear the component instance from memory    
    set XCharge1 = Nothing
 
%>

If you are having trouble getting the component initialized or getting the sample code to run then here are some solutions you can try.

PROBLEM: When trying to use the component in a ASP page or when running the sample ASP scripts included with the component I get an “ActiveX component can't create object” or “Invalid ProgID” error.

RESOLUTION: These errors may occur if the component or one of it's dependencies isn't registered fully on the system.

For the component to function the Visual Basic 6 runtime must be installed and the files “XChargeCom2.dll” (installed to windows\system32 directory) and “wodhttp.dll” (installed to windows\system32 directory) must be registered.

You should run the latest version of the installation program to resolve this problem or alternatively can manually register the component in the registry by following the procedure below:

1. Start a command prompt (click on your start menu, type “cmd.exe” and enter in the run text box).
2. Navigate to your windows system32 directory. By default this directory is called \winnt\system32 on Windows 2000 systems or \windows\system32 on Windows XP or Windows 2003 systems.
3. Type the following commands at the command prompt:
   1. regsvr32 /u XChargeCom2.dll
   2. regsvr32 /u wodhttp.dll
   3. regsvr32 wodhttp.dll
   4. regsvr32 XChargeCom2.dll

PROBLEM: When I try to use the sample ASP scripts or when I try to include the file “xcenums.inc” in my ASP script the following error occurs:

Active Server Pages, ASP 0126 (0×80004005) The include file 'xcenums.inc' was not found.

RESOLUTION: This error occurs because the web server isn't able to locate the file for inclusion. You must provide the full virtual path in your include statement for IIS to properly locate the file. So, for example, if the file was located at the URL: “http://www.mywebsite.com/scripts/payments/xcenums.inc” then your include statement should look like this:

<!– #include virtual=”/scripts/payments/xcenums.inc” –>

PROBLEM: I am using Ensim WEBppliance Pro for Windows and am unable to get the XCharge component to run on my web server (“ActiveX component can't create object” or “Invalid ProgID” error).

RESOLUTION: Ensim WEBappliance Pro imposes a requirement that you must give explicit NTFS permission to WEBappliance to any Active-X component you wish to run under IIS.

You can grant the appropriate permission to WEBappliance Pro to run the XCharge component by following this procedure:

1. Start a command prompt (click on your start menu, type “cmd.exe” and enter in the run text box).
2. Navigate to your windows system32 directory. By default this directory is called \winnt\system32 on Windows 2000 systems or \windows\system32 on Windows XP or Windows 2003 systems.
3. Type the following commands at the command prompt:
   1. regsvr32 /u XChargeCom2.dll
   2. regsvr32 /u wodhttp.dll
4. Create a directory to hold the components, in this example we'll create a folder called components on the root of c drive.
5. Move the files XChargeCom2.dll and wodhttp.dll from the windows system32 directory to the folder you created in the previous step.
6. Start another command prompt (click on your start menu, type “cmd.exe” and enter in the run text box).
7. Navigate to the directory you moved the files to and run the following commands at the command prompt:
   1. regsvr32 XChargeCom2.dll
   2. regsvr32 wodhttp.dll
8. Navigate to a directory a level above the folder you created (In our example this would be the root of c drive) and run the following commands (replacing the word components with name of the folder you created):
   1. cacls components /t /e /r webppliance_siteadmins
   2. cacls components /t /e /g webppliance_siteadmins:R

This removes the webppliance_siteadmins:N permission and thus gives the webppliance_siteadmins access to read this folder and all it's subfolders.

PROBLEM: I can not get the XCharge component to work in ASP.NET.

RESOLUTION: Since the ASP.NET has to use COM Interop to use the XCharge component make sure any ASP.NET project you create that uses the XCharge component has the aspCompat property/attribute set to true.

PROBLEM: When attempting to install the XCharge component I receive the following error: “This setup requires Internet Information Server 4.0 or higher for configuring IIS Virtual Roots. Please make sure that you have IIS 4.0 or higher.”

RESOLUTION: You can safely click the Ignore button to complete installation. This error is normal for computers that don't have IIS installed. The only consequence of clicking the ignore button is that an IIS virtual roots for the ASP.NET example applications will not be created.

PROBLEM: I get the following error when opening the example Microsoft Visual Studio 2003 ASP.NET solution file: “Visual Studio.NET has detected that the specified Web server is not running ASP.NET version 1.1”

RESOLUTION: Make sure of the following.

• You have IIS 4.0 or higher installed and running properly.
• You have Microsoft Visual Studio 2003 installed and running properly.
• You have at least version 1.1 of the .NET framework installed.
• If all the above is true, try the following:
  • Using the command prompt navigate to your .NET framework directory. The framework directory should be located under windows directory, for example “C:\WINDOWS\Microsoft.NET\Framework\v1.xx.xx” (where xx.xx is the latest version of the .NET framework installed on your machine).

In the that directory run the following command:

aspnet_regiis -i

PROBLEM: When attempting to run ASP code you get error E50021 - Unable to verify the first certificate.

RESOLUTION: Make sure the file %SystemRoot%\system32\wodcerts.txt exists and the account that the XCharge component is running under has read access to it.

PROBLEM: When attempting to run ASP code you get error E50027 - Certificate not trusted.

RESOLUTION: Make sure you are running the latest version of the component which includes the most up to date version of the file %SystemRoot%\system32\wodcerts.txt.

To process checks through the component, the merchant must have an account with one of the supported check processors. Please contact support to setup an account or if you have any questions about adding support for check processing. The properties required for processing checks are: SourceKey, Routing, Account, Amount, TransHolderName and identification information. Identification info can either be SSN (social security number) or DLNum and DLState.

The component supports adding customers to a recurring billing cycle automatically. The Recurring property has to be set to a value of TRUE in order for the customer to be added automatically into the Recurring Billing section of the Merchant Console vTerminal. The customer will only be added if the initial charge goes through; therefore the card is charged for the first payment and if approved, is added to the recurring billing cycle. The initial charge and the recurring charge can be different values by using the Amount property as the initial charge and RecurringBillAmount as the recurring charge. If the RecurringBillAmount property is not set then the value of the Amount property will also be the recurring charge.

This component supports VPAS (Verified by Visa) and UCAF (Mastercard Securecode) with both an integrated authentication system and support for third party verification. Using the integrated solution provides a quick and easy method for developers to support Verified by Visa and Mastercard Secure Code without having to deal with the complicated XML messaging formats required.

To use the integrated solution, the merchant must first have an account with Cardinal Commerce. If the merchant does not have an account, but requests authentication, the transaction will be handled as if the cardholder is not enrolled in the Verified by Visa and/or Mastercard Secure Code Program. The following is the process that must be used when using the integrated solution:

1. Merchant's site collects card holder information
2. Merchant's site sends an authorization command with the CardAuth property set to TRUE
3. Component checks to see if the cardholder is enrolled in the Verified by Visa and/or Mastercard Secure Code program. If the cardholder has not set a password then the transaction is approved or declined as usual (component will set ResponseStatus property to 0 - Approved or 1 - Declined). If the cardholder does have a password then the component will set the ResponseStatus property to 2 - Verification indicating that the merchant's site needs to prompt the user for a password. The component will also set the ResponseACSURL and ResponsePayload properties.
4. Merchant's site must send the customers browser to the url contained in the ResponseACSURL property with three get values: PAReq set to the value in ResponsePayload property, TermUrl set to the url on the merchant's site that will continue the transaction, MD set to some identifying information such as order number that will allow the order to continue.
5. Customer enters their username and password. If authentication is successful they will be sent back to TermUrl with the variable PaRes set.
6. Merchant's sends a second authentication request with the component identical to the one sent in step 2 except that the Pares property is set the value of PaRes.
7. Component sets the response properties including the approved or declined status as normal.

If using a third party verification system or if implementing the Cardinal Commerce API on the merchant's side, simply pass XID, CAVV and ECI with the authentication request. Mastercard Secure Code only uses the CAVV property.

Warning: The batch number returned is for the batch that was open when the transaction was initiated. It is possible that the batch was closed while the transaction was processing. In this case the transaction will get queued for the next batch to open.

ver. 2.12.0 (10/10/2007):

• Updated documentation.
• Changed gateway URL to https://secure.usaepay.com/gate.php to reflect newly installed SSL certificate.
• Added IgnoreDuplicate, AmtCurrency, CheckNum, and CptContactless properties.
• Added ResponseIsDuplicate, ResponseConvertedAmount, ResponseConvertedAmountCurrency, ResponseConversionRate, and ResponseCustNum response properties.
• Added 8-creditvoid option to the Command property enumeration.
• Added SetRecurringCustom and GetRecurringCustom methods.
• Documented the -1 flag option for VbV/MC Secure code transactions (applies to CAVV property).
• Added 3-MagSupportContactless option to the CptMagSupport property enumeration.
• Updated wodhttp.dll component to 1.5.4.
• Updated xcenums.inc to include creditvoid and MagSupportContactless constants.
• Updated all examples to reflect new response properties and command enumerations.

ver. 2.9.5 (9/18/2006):

• Updated documentation.
• Added Clerk, Terminal, and Table properties.
• Updated wodhttp.dll component to 1.4.6.

ver. 2.9.3 (11/15/2005):

• Updated documentation.
• Updated errorslist.html documentation.
• Added Tip, Shipping, Discount, OrderID, Subtotal and NonTaxable properties.
• Added ResponseVPASCode and ResponseErrorCode response properties.
• Added next option to the RecurringStartDate property.
• Updated wodhttp.dll component to 1.3.8.
• Added Access and VB.NET control and component examples.
• Updated all examples to reflect new response properties.

ver. 2.8.6 (09/21/2004):

• Updated documentation.
• Updated errorslist.html documentation.
• Updated wodcerts.txt to include information for USAePay's new server certificate. If you are experiencing error E50027: Certificate not trusted make sure you have run the latest install that includes this updated certificate data file.

ver. 2.8.5 (09/13/2004):

• Because of several architectural changes made to the control, this version of the XCharge control is not binary compatible with previous versions. The new control has a new file name, GUID, and ProgID. You should remove/uninstall any previous version of the control you may have in any existing projects and use the new version instead.
• Added Active-X .dll version of XCharge component. For ASP or ASP.NET projects you MUST use the Active-X .dll component version.
• Removed Destroy method. It is no longer needed.
• Updated xcenums.inc to include CptTermTypeType and CptMagSupportType constants.
• Removed ASP examples for control, added ASP, ASP.NET, VB, C#, and C++ examples for .dll component. Updated all other examples.
• Updated wodhttp.dll component to 1.2.1.8.
• Updated errorslist.html documentation.
• Fixed typo so that the prefix Reponse is correctly spelled as Response for the following properties: ResponseAVS, ResponseAVSCode, ResponseCVV2 and ResponseCVV2Code.

ver. 2.8.0 (08/14/2004):

• Added Destroy method.
• Added card present support with new properties: CptCardPresent, CptMagStripe, CptTermType, CptMagSupport.
• Added Software property.
• Added ResponseBatch response property.
• Updated wodhttp.dll component to 1.2.1.5.
• Updated errorslist.html documentation.
• Updated VB, ASP, C#, C++, and ASP.NET examples.
• Added ASP.NET Web Matrix sale charge example.
• Added ASP.NET barebones aspx sale charge example.
• Various small bug fixes.

ver. 2.7.0 (01/27/2004):

• Added new ResponseAVSCode and ResponseCVV2Code properties.
• Added Pin and MD5Key properties, implementing new source pin feature.
• Added C# (C Sharp) and ASP.NET examples.
• Updated VB and ASP examples.
• Updated wodhttp.dll component to 1.2.0.7.
• Fixed occurrence of error “E1004 : Credit Card Number is required.” when “Command” property is set to 6-check.

ver. 2.5.4 (01/24/2004):

• Fixed credit command not working under certain circumstances.

ver. 2.5.3 (11/13/2003):

• Changed the method the installation program uses to register the required components, the older method was causing the control to not be fully registered for use under IIS under some Windows 2000 server configurations.
• If you're getting a “ActiveX component can't create object” or “Invalid ProgID” error we recommend you download and install this version of the control or newer to fix this problem.
• Alternatively you can try this hot fix:
  1. Start a command prompt (click on your start menu, type “cmd.exe” and enter in the run text box).
  2. Navigate to your Windows system32 directory .
  3. Type the following commands at the command prompt:
     1. regsvr32 /u xcharge.ocx
     2. regsvr32 /u wodhttp.dll
     3. regsvr32 wodhttp.dll
     4. regsvr32 xcharge.ocx

ver. 2.5.2 (10/22/2003):

• Added support for biannually value in RecurringSchedule property.

ver. 2.5.1 (10/15/2003):

• Complete re-write of XCharge control. It is recommended you uninstall and cease use of any previous version of this control. This control is NOT compatible with previous versions.
• You may still download version 2.2 by clicking here.