Integration and Documentation
The Developer Library contains documentation, examples, source code and controls for integrating our gateway into your software.
Transaction API
The basic protocol for connecting to the gateway. Can be used either directly via a form or transparently via a CGI running on the merchant’s own webserver.
PHP Library
A simple class that provides an easy-to-use object-oriented interface to the USAePay gateway. Compatible with PHP4 or PHP5. Requires CuRL or PHP SSL Streams support.
Java Library
A complete Java implementation of the SOAP Interface. Include Jax-WS and Jax-RPC versions.
Coldfusion Library
Provides a tag for use in Coldfusion Scripts.
Ruby Library
Easy to use Ruby interface for running server to server processing.
Advanced Soap API
In addition to processing transactions, the SOAP interface may be used to pull reports, control batches, store customer data and automate reseller functionality.
.Net DLL
A .NET class that allows developers to process cards via .NET applications. Includes easier to use wrappers to some SOAP Interface functions.
Com Object V2.0
An updated COM Object that can be used with any programming language that supports COM, including C and ASP.
JavaScript Code
Client-side JavaScript which works with USAePay.
PHP
<?php try { &Request=array( 'AccountHolder' => 'Tester Jones', 'Details' => array( 'Description' => 'Example Transaction', 'Amount' => '4.00', 'Invoice' => '44539' ), 'CreditCardData' => array( 'CardNumber' => '4444555566667779', 'CardExpiration' => '0909', 'AvsStreet' => '1234 Main Street', 'AvsZip' => '99281', 'CardCode' => '999' ) ); $res=$client->runSale($token, $Request); } catch (SoapFault $e) { echo $client->__getLastRequest(); echo $client->__getLastResponse(); die("QuickSale failed :" .$e->getMessage()); } ?>
JAVA
try { TransactionRequestObject params = new TransactionRequestObject(); // set card holder name params.setAccountHolder("Test Joe"); // populate transaction details TransactionDetail details = new TransactionDetail(); details.setAmount(22.34); details.setDescription("My Test Sale"); details.setInvoice("119891"); params.setDetails(details); // populate credit card data CreditCardData ccdata = new CreditCardData(); ccdata.setCardNumber("4444555566667779"); ccdata.setCardExpiration("0912"); ccdata.setCardCode("999"); params.setCreditCardData(ccdata); // Create request object RunSale request = new RunSale(); request.setToken(token); request.setParams(params); // Create response object TransactionResponse response; // run sale response = client.runSale(token, params); System.out.println("Result: " + response.getResult()); } catch (Exception e) { System.out.println("Soap Exception: " + e.getMessage()); }
VB.NET
Dim client As usaepay.usaepayService = New usaepay.usaepayService Dim token As usaepay.ueSecurityToken token = Me.CreateToken("714SSUxv1uohng2XkMJ7kLpETsu58G66", "1234") Dim transaction As usaepay.TransactionRequestObject = New usaepay.TransactionRequestObject transaction.CreditCardData = New usaepay.CreditCardData transaction.CreditCardData.CardNumber = "4444555566667779" transaction.CreditCardData.CardExpiration = "0913" transaction.CreditCardData.CardCode = "999" transaction.Details = New usaepay.TransactionDetail transaction.Details.Amount = 9.02 transaction.Details.AmountSpecified = True transaction.Details.Invoice = "434534" transaction.Details.Description = "Example transaction" Dim response As usaepay.TransactionResponse response = client.runSale(token, transaction) If response.ResultCode = "A" Then MsgBox("Transaction Approved, Reference Number: " & response.RefNum & vbLf _ & "AVS Result: " & response.AvsResult) ElseIf response.ResultCode = "D" Then MsgBox("Transaction Declined, Reason: " & response.Error) Else MsgBox("Transaction Error, Reason: " & response.Error) End If
.NET C#
usaepay.TransactionRequestObject tran = new usaepay.TransactionRequestObject(); tran.Details = new usaepay.TransactionDetail(); tran.Details.Amount = 1.00; tran.Details.AmountSpecified = true; tran.Details.Invoice = "1234"; tran.Details.Description = "Example Transaction"; tran.CreditCardData = new usaepay.CreditCardData(); tran.CreditCardData.CardNumber = "4444555566667779"; tran.CreditCardData.CardExpiration = "1212"; usaepay.TransactionResponse response = new usaepay.TransactionResponse(); try { response = client.runTransaction(token, tran); if (response.ResultCode == "A") { MessageBox.Show(string.Concat("Transaction Approved, RefNum: ", response.RefNum)); } else { MessageBox.Show(string.Concat("Transaction Failed: ", response.Error)); } } catch (Exception err) { MessageBox.Show(err.Message); }
XML
192.168.0.1
11ac55b0a0b59f8f028dbf85bc32266fa973dd0e
12678150211876663375
sha1
HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT
Tester Jones
1234 Main Street
99281
999
1212
4444555566667779
Details
4 Example Transaction 44539
ePayment Form
The ePayment Form allows a merchant to send the customer to USAePay for the collection of secure payment information. This eliminates the need for individual merchants to maintain their own SSL certificates. To implement the payment form, the merchant’s website needs to redirect the customer to a specially formatted URL, display a form that will post to the USA ePay site, or display a button that’s connected to the form. Before creating the URL/form/button please see the sources section in order to setup the source key within the USAePay Merchant Console. You will need the source key to connect to the gateway.
Shopping Cart
USAePay offers a full list of compatible shopping carts.
POS Systems
USAePay maintains a list of known compatible POS/ERP Systems.
Authorize.net Emulation
We highly recommend that you rewrite your application to use our gateway APIs. In some cases, this is impossible, and we offer another approach – gateway emulation.
We can emulate your gateway request and response calls without you having to change your code. Minimal modification will be required such as changing the processing URL and authentication.
Learn more about USAePay’s Authorize.net Emulator.
Online Reporting
Time is money. Many business owners could easily say they would like more of both. With speed in mind, our online reporting system has been set up to provide you with a level of detail expected of someone who is very cost-conscious and organized, but also wants something user-friendly and adaptable.
WHAT DOES THE ONLINE REPORTING SYSTEM ACTUALLY TELL ME?
- Transactions
- Batches
- Deposit orders sent to your bank
- Returns
- Voided Transactions
- Cancellations
Recurring Billing
Using the Customer Vault, merchants have the ability to arrange repeat billing according to their particular specifications. You’ll have the ability to arrange billing, setting your own amounts, frequency and duration. The system does the rest for you.
Customer Vault
Security for any merchant is of paramount importance. Customers put enormous trust in a merchant whenever they use online payment services of any kind. With the proper procedures and protocols in place, the convenience of online transactions can continue to entice customers to go to you. One of the methods we use to keep information secure, while providing a smooth transaction method, is called the Customer Vault.
So, What Exactly Is the Customer Vault?
Customer Vault securely stores customers’ sensitive information, so you don’t have to.
- This allows you the ability to use recurring billing without obtaining a customer’s payment information every time you wish to make a transaction with them.
- This information is protected in a secure, encrypted state. When you need to issue a charge, the system uses a “key” so that the information is not seen, but transactions can be arranged anyway–limiting your exposure to identity theft and related problems.
- The information is stored outside of your own system, protecting you from unnecessary risk, as well as applicable regulatory requirements that must be met when storing this type of information.