Soap Interface Documentation
- Getting Started
- Methods
- Objects
- Release Notes
  - 1.1
  - 1.0
  - BETA 6
  - BETA 5
  - BETA 4
  - BETA 3
  - BETA 2

Soap Interface Documentation

Current Version: 1.1 (see release notes for more details about current and past versions)

The Soap interface provides a collection of methods implementing a large portion of merchant and reseller functionality.

Methods

Transactions

runTransaction	Runs a transaction using the Transaction API.
runTransactionAPI	Provides a Soap wrapper for the Transaction API.
runSale	Run a new sale (debit) transaction for credit cards.
runAuthOnly	Run a new authonly (debit) transaction for credit cards.
runCredit	Run a credit transaction for credit cards.
runCheckSale	Run a new sale (debit) transaction for checks.
runCheckCredit	Run a credit transaction for checks.
runQuickSale	Run a sale based on the credit card or check details of a previous transaction.
runQuickCredit	Run a credit based on the credit card or check details of a previous transaction.
postAuth	Post an offline authorization
captureTransaction	Capture a queued transaction.
refundTransaction	Refund a specific transaction.
overrideTransaction	Override a specific transaction.
voidTransaction	Void a specific transaction.
getTransactionStatus	Retrieve the current status of a specific transaction.
getTransaction	Retrieves all details of a specified transaction.
getTransactionCustom	Retrieves only selected details of a specified transaction.
searchTransactions	Search transactions and return full transaction records.
searchTransactionsCustom	Search transactions and return only specific fields.
getTransactionReport	Pull a transaction report.
convertTranToCust	Convert a transaction data to a stored customer record.

Batch Uploads

createBatchUpload	Post a new batch of transactions to the gateway for processing.
runBatchUpload	Resume processing a paused batch upload.
pauseBatchUpload	Pause a Batch Upload that is already running.
getBatchUploadStatus	Retrieve the status of a currently running batch.

Credit Card Batches

searchBatches	Search previously settled batches.
getBatchStatus	Retrieves the status of a batch specified by its BatchNum.
closeBatch	Close a batch specified by BatchNum.
getBatchTransactions	Retrieve transactions in the batch specified by BatchNum

Customers

runCustomerTransaction	Run a transaction using payment data stored in the customer database.
enableCustomer	Enable recurring billing for a customer specified by CustNum.
disableCustomer	Disable the recurring billing for a customer specified by CustNum.
deleteCustomer	Delete the customer specified by CustNum.
searchCustomerID	Find a CustNum (assigned by the gateway) using a CustID (assigned by merchant).
getCustomer	Retrieve the customer details for a given CustNum.
searchCustomers	Search for customers.
searchCustomersCustom	Search for customers, returning custom columns.
getCustomerHistory	Pull details of all transactions run for CustNum.
addCustomer	Add a customer to your stored customer database.
addCustomerPaymentMethod	Add a payment method for an existing customer.
deleteCustomerPaymentMethod	Delete a payment method from an existing customer.
updateCustomer	Replace all data for customer specified by CustNum.
quickUpdateCustomer	Update customer data in selected fields only.
copyCustomer	Copy customer from one merchant account to another.
moveCustomer	Move customer from one merchant account to another.

General Merchant Methods

getAccountDetails	Retrieves information about merchant account.
getSupportedCurrencies	Retrieves an array of currencies supported by a merchant account.
currencyConversion	Find currency conversion rate for a transaction amount.
bulkCurrencyConversion	Converts multiple amounts in a single method call.

Reseller Methods

addMerchantApplication	Add a new merchant application to the system.
getMerchantApplicationStatus	Retrieve the status of a pending merchant application.
getMerchant	Retrieve details of a merchant's account.
updateMerchant	Update details in a merchant's account.
deleteMerchant	Request deletion of merchant account.
searchMerchants	Search active merchants.
getMerchantSummary	View summary of merchant activity.

Objects

AccountDetails	Contains all relevant data pertaining to a merchant account.
Address	Contains customer contact information.
BatchStatus	Contains information about a batch awaiting settlement.
BatchUploadStatus	Contains information on an uploaded batch.
CheckData	Contains information for electronic check transactions.
CheckTrace	Electronic check transaction tracking data.
CreditCardData	This object contains credit card specific information for a transaction.
CurrencyConversion	Contains the results of a currency conversion.
CurrencyObject	Describes a currency supported by the merchant's account.
CustomerObject	Contains customer data.
CustomerSearchResult	Contains customer search data.
FieldValue	Generalized Field-Value Pair
MerchantApplicationObject	Contains information for a new merchant application.
MerchantObject	Contains contact information for an active merchant.
MerchantSearchResult	Contains the results of a merchant search.
MerchantSummaryObject	Summary of merchant activity over a given time period.
PaymentMethod	Describes a customer payment method.
RecurringBilling	This object stores information relating to specific recurring billing cycles.
SearchParam	Used to create a unique search parameter.
TransactionDetail	Contains transaction specific data.
TransactionObject	Contains all transaction data.
TransactionRequestObject	Used to run a new transaction.
TransactionResponse	Contains details on the result of a processed transaction.
TransactionSearchResult	Contains results of a transaction search.
ueHash	Defines the properties of the hash used to validate a source key.
ueSecurityToken	Defines a source key used to identify a merchant or reseller.

Release Notes

1.1

The following methods have been implemented: copyCustomer, and moveCustomer.

The following changes have been made in 1.1:

The DUKPT and Signature properties have been added to the CreditCardData object
The Comments property have been added to the TransactionDetail object

1.0

The following methods have been implemented: convertTranToCust, deleteCustomerPaymentMethod, overrideTransaction, refundTransaction, runAuthOnly, runCheckCredit, runCheckSale, runQuickCredit and searchCustomersCustom.

The following changes have been made in 1.0:

PaymentMethod object has been added to the CustomerObject
runAuthOnly method added - run a direct authonly transaction
runCheckSale method added - run a sale transaction based on bank account rather than credit card information
runCheckCredit method added - run a credit transaction based on bank account rather than credit card information
runQuickCredit method added - run a credit based on the credit card details of a previous transaction
refundTransaction method added - refund a specific transaction using the transaction ID
overrideTransaction method added - override a specific transaction that has been flagged for manager approval (currently applies only to check transactions)
convertTranToCust method added - convert the information from a specific transaction to stored customer data
deleteCustomerPaymentMethod method implemented - delete a payment method from an existing customer account
searchCustomersCustom method added - search customer records and return only specified fields
checkData object modified to include AccountType property, denotes type of account being debited
customerObject modified to include CustomFields parameter, Tax parameter, and PaymentMethods, and to remove CheckData and CreditCardData parameters
transactionObject modified to include Response property - displays transaction result (approved, declined, error, etc.)
transactionResponse object modified to include Status and Status Code properties - display description of status and single character transaction status code respectively

This is the last beta before our 1.0 release. All methods have now been implemented with the exception of addCustomerPaymentMethod and deleteCustomerPaymentMethod, which have limited functionality within this beta release.

The following changes have been made in Beta6:

All unimplemented methods, such as runSale, have been completed.
runOldApi has been replaced with runTransaction.
getAccountDetails has been added to allow automatic retrieval of merchant account capabilities.
Multi Currency methods have been added: currencyConversion, bulkCurrencyConversion, and getSupportedCurrencies.
TransactionResponse has been updated to include new result variables such as isDuplicate.
getTransactionCustom method has been added to allow quick and efficient retrieval of any transaction field.
searchTransactionsCustom method has been added to allow a customizable list of transaction fields to be returned.
getTransactionReport method has been added to allow the retrieval of any reports available in the merchant console.
runCustomerSale has been renamed runCustomerTransaction.
runCustomerTransaction, and addCustomer have been altered to support electronic check data.
All data types have been fully speced, all AnyTypes have been removed.
Unit testing is now complete for PHP5, VB, .Net v2, and Java NetBeans.

BETA 5

The following methods have been implemented: searchCustomers, runCustomerSale, addCustomer, and updateCustomer.

The following new objects have been added: CustomerSearchResult, CreditCardData & CheckData. These new objects replace arrays and may break compatibility with beta4 on methods such as getCustomer. The beta5 release also includes various bug fixes.

BETA 4

This release rounds out support for most of the missing methods and improves compatibility with .NET.

BETA 3

This release implements PinHash. Many methods now require that a pin is assigned to the source key and that the PinHash component of the SecurityToken is correctly filled out. If you are using a source key that does not have a pin assigned, you will have to log into the merchant console and edit the key.

BETA 2

Please be aware that the transaction methods (runSale, runCredit, etc) are currently disabled. We are implementing a new fraud module stack and these methods are tied to the new stack. Once the new fraud system is released, these methods will be enabled. In the meantime, please use the runOldAPI function for transaction processing.