The USAePay Soap interface provides a collection of functions implementing
a large portion of merchant functionality.
Add a Stored Customer Record
Add Payment Method For a Customer
Add a new product
Add a new product category
Add a new receipt template
Adjust product inventory
Convert multiple currency amounts in a single method call
Capture a queued transaction
Close the batch specified by BatchRefNum
Convert existing transaction into a stored customer.
Copy customer from one source key to another
Post a new batch of transactions to the gateway for processing.
Lookup currency conversion rate for single dollar amount.
Delete the customer specified by CustNum
Delete Payment Method
Delete product specified by ProductRefNum.
Delete product category specified by ProductCategoryRefNum.
Delete a customer receipt template
Disable the recurring billing for the customer specified by CustNum
Email a transaction receipt specified by ReceiptRefNum
Email a transaction receipt specied by ReceiptName
Enable recurring billing for the customer specified by CustNum
Retrieves Information about Merchants account
Retrieves list of banks and financial institutions available for direct payment
Retrieve the status of the batch specified by BatchRefNum
Retrieve transactions in the batch specified by BatchRefNum
Retrieve the status of the currently running batch.
Retreive all check status data for the transactions specified by RefNum
Retrieve the customer details for the given CustNum
Pull details of all transactions run for CustNum
Retrieve a specific customer Payment Methods for the given CustNum/MethodID
Retrieve the customers Payment Methods for the given CustNum
Pull a customer report
Retrieve the custom fields defined by merchants
Retrieve the product details for the given ProductRefNum
Retrieve the product category details for the given ProductCategoryRefNum
Retreive list of product categories
Retrieve the product inventory
Retreive a receipt template by RefNum
Retreive a receipt template by receipt name
Retreive list of receipt templates by target
Pull a merchant report
Retrieve Supported Currencies
Retrieve changes to data objects made on the server
Returns the last position in the change log for a given object
Retreive information about service
Retreive all information for the transactions specified by RefNum
Get Specific Transaction Details
Pull a transaction report
Retrieve the current status of transaction specified by RefNum
Move customer from one source key to another
Pause a Batch Upload that is already running
Post an Offline Authorization
Update specified data for customer specified by CustNum
Update specified data for product specified by ProductRefNum
Refund part or all of a transaction
Render receipt for transaction
Render receipt for transaction
Start a Paused Batch Upload
Run a Credit transaction
Run a Check Credit transaction
Run a sale for a customer stored in the customer database
Run a sale based on the credit card details of a previous transaction.
Run a credit based on the credit card details of a previous transaction.
Run an AuthOnly Credit Card Sale
Run a Credit CardSale
Run a Check Sale
Runs a Transaction using the USAePay Transaction API
Provides a Soap wrapper for the USAePay Transaction API
Search Settled Batches
Search Settled Batches, return counts only
Find the customer refnum (CustNum) associated with the userdefined CustID
Search customer database
Search customer database return only count of what was found
Search Products
Search Products, return counts only
Search Products and return custom response
Search transactions and return transaction records
Search transactions and return counts, omit tran data
Search Transactions and return specified fields
Search Customers and return specified fields
Replace all data for customer specified by CustNum
Update a Customer Payment Method
Replace all data for product specified by ProductRefNum
Replace all data for product category specified by ProductCategoryRefNum
Update receipt template
Void the transaction specified by RefNum
Override the transaction specified by RefNum