Soap API Release Notes

View SOAP 1.4 HTML documentation

• No new methods were added in 1.4

• PriceTier - Object describing product qty/customer price tiers

• Modified TransactionDetail object - Added AllowPartialAuth parameter which enables partial authorization if full auth amount is not available
• Modified TransactionDetail object - Change Currency parameter from integer to string
• Modified TransactionResponse object - Added AuthAmount and RemainingBalance parameters
• Modified CheckData object - Removed SSN parameter, Added AuxOnUS, EpcCode, FrontImage and BackImage parameters

• Modified CustomerObject object - Added LookupCode, PriceTier and TaxClass parameters for POS integration
• Modified CustomerObject object - Changed Currency parameter from integer to string
• Modified PaymentMethod object - Added MethodType parameter. Implement two new payment types: StoredValue and Invoice. Added parameters: Balance, MaxBalance, AutoReload, ReloadSchedule, ReloadThreshold, ReloadAmount, ReloadMethodID parameters for new method types.

• Modified Product object - add TaxClass and PriceTiers parameters

• Modified CurrencyConversion object - Changed Currency and FromCurrency parameters from integer to string (to prevent issues with leading zeros)
• Modified currencyConversion method - Change FromCurrency and ToCurrency parameters from integer to string

View SOAP 1.3 HTML documentation

• getCheckTrace - allow the retrieval of check status information without over head of full getTransaction
• emailTransactionReceipt - Emails a new receipt for an existing transaction. Receipt template selected by id.
• emailTransactionReceiptByName - Emails a new receipt for an existing transaction. Receipt template selected by name.
• getCustomerReport - Alias to getReport method. (added for consistency)
• getReport - Pull built in and custom reports from the merchant console
• getCustomFields - return the merchants list of custom fields
• getReceipt - Retrieve receipt template (By RefNum)
• getReceiptByName - Retrieve receipt template (By Name)
• addReceipt - create a new receipt template for merchant
• updateReceipt - update an existing receipt
• deleteReceipt - delete an existing receipt or remove customization from built in receipt
• getReceipts - retrieve array of receipt templates.
• renderReceipt - takes a receipt name and transaction ref num and returns text/html receipt
• renderReceiptByName - takes a receipt name and transaction ref num and returns text/html receipt
• getSyncLog - allow pulling list of gateway db changes (customers, products and invoices) by sequential position number. Makes syncing information with gateway easier.
• getSyncLogCurrentPosition - returns the last position in the sync log (useful when setting up a new sync partner)
• getSystemInfo - returns information about server (Soap API version, environment, datacenter and current time).
• addProduct - Add a new product to the gateway
• updateProduct - Update an existing product
• deleteProduct - Delete existing product
• getProduct - Retrieve product object
• getProductInventory - Retrieve array of ProductInventory objects describing a products current inventory levels
• adjustInventory - Adjust the inventory levels
• quickUpdateProduct - Update specific product fields only.
• searchProducts, searchProductsCustom, searchProductsCount - methods that allow for searching products db.
• addProductCategory - Create a new product category
• getProductCategory - Retrieve a product category
• updateProductCategory - Update an existing product category
• deleteProductCategory - Delete an existing product category
• getProductCategories - Retrieve array of product categories

• CustomerTransactionRequest - new request object (includes Command, isRecurring, CardCode (CVV2), receipt request flags and TransactionDetails Object)
• LineItem - Object describing transaction line item detail
• Product - Product Object
• ProductCategory - Product Category Object
• ProductInventory - Object describing inventory for a given product at a given warehouse (inventory location)
• ProductSearchResult - Object describing a product search result
• Receipt - Receipt template
• SyncLog - Description of change from sync log
• SystemInfo - Information about the api/gateway connected to

• Modified CheckTrace - add Status,StatusCode, ReturnCode and Reason properties
• Modified searchTransactions, searchTransactionsCustom, searchTransactionsCount - add the ability to search by custom fields (by both the numerical indexes and the field names)
• Modified searchTransactionsCustom - add support for PHP and JSON export formats
• Modified TransactionRequestObject - add CustomFields property to allow sending custom fields in with transactions
• Modified TransactionResponse Object - Add CardLevelResultCode and CardLevelResult to indicate visa card types (like UMcardLevelResult in transaction api).
• Modified TransactionRequestObject - add CustReceiptName to allow select of which receipt template to use
• Modified TransactionObject and TransactionRequestObject - added LineItems parameter for transaction line item detail

• Modified CustomerObject - Add URL parameter
• Modified addCustomer, updateCustomer, quickUpdateCustomer - Correctly store User parameter
• Modified runCustomerTransaction - correctly store credits under customer history
• Drop CustomerTransactionDetail object - properties will be moved into new CustomerTransactionRequest object
• Modified runCustomerTransaction method - Drop Details and Command arguments, Add Parameters argument of type CustomerTransactionRequest
• Modified PaymentMethod object - Dropped the CreditCard and CheckData objects. Add new parameters: Account, AccountType, DriversLicense, DriversLicenseState, RecordType, Routing, AvsStreet, AvsZip, CardCode, CardExpiration, CardNumber and CardType
• Modified addCustomerPaymentMethod - Add option to validate CVV (CVV can be supplied in the payment method and will be validated on addCustomerPaymentMethod call)

• Modify the SearchParam object to support EW (ends with), SW (starts with), IN and NOT IN search types.

View SOAP 1.2 HTML documentation

• Added getCustomerPaymentMethod method to retrieve a specific payment method
• Added getCustomerPaymentMethods method to retrieve all payment methods for a customer
• Added updateCustomerPaymentMethod method to update a specific payment method
• Modified searchTransactions, searchTransactionsCustom, searchCustomers, searchCustomersCustom, searchBatches and searchMerchants methods to include Sort parameter. Allows for sorting search results
• Added searchCustomersCount, searchTransactionsCount, searchBatchesCount and searchMerchantsCount methods to return search result info without transferring all data.
• Modified searchCustomers, searchCustomersCustom to support object oriented field names. Added support for searching by source name and schedule.
• Modified searchTransactions, searchTransactionsCustom methods. Added support for searching by ccnum last 4.
• Added searchMerchantsCustom method to pull a customized search result on merchants
• Added getBankList method which pulls the list of banks that the merchant can accept direct payments from. Only available to merchants setup to process Secure Vault Payments
• Modified AccountDetails object, added DebitCardSupport parameter to indicate whether the merchant is setup to precess pin debit cards
• Modified AccountDetails object, added DirectPayPlatform paramter to indicate whether the merchant supports direct bank payments (Secure Vault Payments).
• Added CustomerTransactionDetail object with additional parameters (CVV and isRecurring) that are specific to customer payments.
• Modified runCustomerTransaction to use CustomerTransactionDetail, adds parameter isRecurring to allow flagging a customer transaction as recurring and CVV to allow passing cvv code
• Modified TransactionObject object, added CustomFields parameter
• Modified PaymentMethod object, added the Created and Modified parameters
• Modified TransactionResponse object, added the BatchRefNum parameter (BatchRefNum is the USAePay assigned batchid, the existing BatchNum parameter is the batch sequence number)
• Modified runBatchUpload, pauseBatchUpload and getBatchUploadStatus methods, renamed BatchNum parameter to UploadRefNum
• Modified BatchUploadStatus object, renamed BatchNum parameter to UploadRefNum
• Modified getBatchStatus, closeBatch and getBatchTransactions methods, renamed BatchNum parameter to BatchRefNum
• Modified BatchStatus object, rename BatchNum parameter to BatchRefNum

View SOAP 1.1 HTML documentation

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

Documentation is not currently available for version 1.0. Please refer to the WSDL file for list of methods and objects. For further assistance, please contact developer support.

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

Documentation is not currently available for version 0.6 Please refer to the WSDL file for list of methods and objects. For further assistance, please contact developer support.

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.

Documentation is not currently available for version 0.5 Please refer to the WSDL file for list of methods and objects. For further assistance, please contact developer support.

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.

Documentation is not currently available for version 0.6 Please refer to the WSDL file for list of methods and objects. For further assistance, please contact developer support.

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

Documentation is not currently available for version 0.3 Please refer to the WSDL file for list of methods and objects. For further assistance, please contact developer support.

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.

Documentation is not currently available for version 0.2 Please refer to the WSDL file for list of methods and objects. For further assistance, please contact developer support.

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.