Soap API Release Notes
Version 1.4
Documentation
New Methods
New Objects
PriceTier - Object describing product qty/customer price tiers
Changes From Previous Release
Transactions
-
-
-
Modified
CheckData object - Removed SSN parameter, Added AuxOnUS, EpcCode, FrontImage and BackImage parameters
Customers
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.
Products
Modified
Product object - add TaxClass and PriceTiers parameters
Misc
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
Version 1.3
Documentation
New Methods
getCheckTrace - allow the retrieval of check status information without over head of full getTransaction
-
-
-
getReport - Pull built in and custom reports from the merchant console
-
getReceipt - Retrieve receipt template (By RefNum)
-
addReceipt - create a new receipt template for merchant
-
deleteReceipt - delete an existing receipt or remove customization from built in receipt
-
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.
-
getSystemInfo - returns information about server (Soap
API version, environment, datacenter and current time).
-
-
-
-
getProductInventory - Retrieve array of ProductInventory objects describing a products current inventory levels
-
-
-
-
-
-
-
-
New Objects
CustomerTransactionRequest - new request object (includes Command, isRecurring, CardCode (CVV2), receipt request flags and TransactionDetails Object)
LineItem - Object describing transaction line item detail
-
-
ProductInventory - Object describing inventory for a given product at a given warehouse (inventory location)
-
-
SyncLog - Description of change from sync log
SystemInfo - Information about the api/gateway connected to
Changes From Previous Release
Transactions
Modified
CheckTrace - add Status,StatusCode, ReturnCode and Reason properties
-
-
-
Modified
TransactionResponse Object - Add CardLevelResultCode and CardLevelResult to indicate visa card types (like UMcardLevelResult in transaction api).
-
-
Customers
-
-
-
-
-
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)
Misc
Modify the
SearchParam object to support EW (ends with), SW (starts with), IN and NOT IN search types.
Version 1.2
Documentation
Changes From Previous Release
-
-
-
-
-
-
-
-
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
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
BatchStatus object, rename BatchNum parameter to BatchRefNum
Version 1.1
Documentation
Changes From Previous Release
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
-
Version 1.0
Documentation
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.
Changes From Previous Release
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:
-
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
-
-
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
Version 0.6 (Beta 6)
Documentation
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.
Changes From Previous Release
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.
-
getAccountDetails has been added to allow automatic retrieval of merchant account capabilities.
-
-
getTransactionCustom method has been added to allow quick and efficient retrieval of any transaction field.
-
getTransactionReport method has been added to allow the retrieval of any reports available in the merchant console.
-
-
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.
Version 0.5 (Beta 5)
Documentation
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.
Changes From Previous Release
Version 0.4 (Beta 4)
Documentation
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.
Changes From Previous Release
This release rounds out support for most of the missing methods and improves compatibility with .NET.
Version 0.3 (Beta 3)
Documentation
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.
Changes From Previous Release
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.
Version 0.2 (Beta 2)
Documentation
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.
Changes From Previous Release
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.