USAePay Developer Support

USA ePay's Developer Library contains documentation, examples, source code and controls for integrating our gateway into your software.

Developer's Reference - Quick Reference guide for integrating

Sandbox Test Account - The sandbox provides a full simulation of the production gateway and is the ideal way to test your integration

SSL Client Certificates - Accessing the full card number and expiration date while signed into the merchant console.

Basic Integration

ePayment Form

The payment form allows a merchant to send the customer to USAePay for the collection of secure payment information

Shopping Carts & Software

Full listing of compatible carts

Shopping Cart tutorials

A list of tutorials for carts with payment module installation

Point of Sale (POS) Systems

Known Compatible POS/ERP Systems

Integration APIs

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.

Advanced SOAP Interface

A thorough SOAP interface that provides extensive functionality. In addition to processing transactions, the soap interface may be used to pull reports, control batches, store customer data and automate reseller functionality.

Language Specific Libraries

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.


A .NET class that allows developers to process cards via .NET applications. Includes easier to use wrappers to some SOAP Interface functions.

Java Library

A complete java implementation of the Soap API v1.6.

COM Object v2.0

An updated COM Object that can be used with any programming language that supports COM, including C and ASP.

Coldfusion Library

Provides a tag for use in Coldfusion Scripts.

JavaScript Code

Client-side JavaScript which works with USA ePay.

jQuery Library

Client-side jQuery plugin which works with USA ePay.

Ruby Library

Easy to use Ruby interface for running server to server processing.


A third party CPAN module that's part of the Business::OnlinePayment framework. For help with this module please contact its maintainer.

iOS Library

Easy to use iOS library for payment processing.

iOS usaepayMiddleware

Easy to use iOS library for payment processing.

Android Library

Easy to use Android library for payment processing.

3rd Party Tools

If you can't find what you're looking for please try the.

Deprecated (Will no longer be supported)

The following APIs/Libraries/components will no longer be supported by USAePay's Integration Support for new accounts. If you are an existing account and still using one of these APIs/Libraries/components we will provide limited support but encourage you to use newer integration methods listed above.

COM Object

A universal COM Object that can be used with any programming language that supports COM, including C and ASP.

xCharge Active-X Control

An ActiveX control that can be used by developers to easily process cards from within their own programs or ASP scripts.

Delphi Visual Component Library

A Delphi VCL program and example.

Migrating from other gateways

developer/support.txt · Last modified: 2018/02/26 16:42 by yura

Page Tools