developer:soap:support

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developer:soap:support [2010/02/12 15:53]
tem
developer:soap:support [2010/08/27 10:26]
tem
Line 1: Line 1:
-====== Soap API v1.2 Documentation ====== +<​embed ​developer:​soap-1.4:Support/>​
- +
-The USAePay [[http://​en.wikipedia.org/​wiki/​SOAP_(protocol)|SOAP]] API provides a standardized web services interface that allows developers to leverage much of the gateway functionality within their applications. ​ The API is designed to give developers the tools necessary to create highly customized payment applications. ​ Since the API uses web standards, ​ it is directly supported by many programming languages such as Dot Net and PHP. +
- +
-===== Versioning ===== +
- +
-SOAP uses [[http://​en.wikipedia.org/​wiki/​Web_Services_Description_Language|WSDL]] files to describe the methods and objects that are made available by a webservice. ​ With each new version of the USAePay soap API a new WSDL file is released. Once a version of the API is released, it's corresponding WSDL file will not change. ​ This allows developers to continue to use an older version of the API indefinitely without the risk of future releases breaking existing code.  There is no need to upgrade to the latest version unless new functionality is desired. There is also no restriction on the number of WSDL files used by an application. Existing code can continue to use the old WSDL while newly added code can use a second WSDL link. +
- +
-To create a WSDL link for your application you must login into the [[https://​www.usaepay.com/​developer/​login|Developer'​s Center]]. ​ Once logged in,  click on "Add Software"​. +
- +
- +
-**Current Version: ** 1.2 (see [[developer:​soap:​releasenotes|release notes]] for more details about current and past versions including documentation) +
- +
- +
-===== Getting Started ===== +
- +
-The following guides give specific setup instuctions/​background information on using Soap with some of the more common programming languages. If you are using a language not listed below, please feel free to contact us for assistance. The Soap interface can be used with any programming language that is able to communicate with an HTTPS connection.  +
- +
-  * [[developer:​soap:​howto:​php|PHP 5 (Built-in SoapClient)]] +
-  * [[developer:​soap:​howto:​pearsoap| PHP 5 (Pear Library)]] +
-  * [[developer:​soap:​howto:​vb|Visual Basic (.Net)]] +
-  * [[developer:​soap:​howto:​vb2010|Visual Basic 2010 (.Net 4.0)]] +
-  * [[developer:soap:​howto:​csharp|C# ​ (.Net)]] +
-  * [[developer:​soap:​howto:​javajaxrpc|Java (NetBeans with JAX-RPC)]] +
-  * [[developer:​soap:​howto:​javajaxws|Java (JAX-WS, Apache CFX)]] +
- +
- +
-===== Methods ===== +
- +
- +
-==== Transactions ==== +
- +
-| [[developer:​soap:​methods:​runTransaction|runTransaction]] ​ | Runs a transaction using the Transaction API. |  +
-| [[developer:​soap:​methods:​runTransactionAPI|runTransactionAPI]] ​ | Provides a Soap wrapper for the Transaction API. | +
-| [[developer:​soap:​methods:​runSale|runSale]] | Run a new sale (debit) transaction for credit cards. ​  | +
-| [[developer:​soap:​methods:​runAuthOnly|runAuthOnly]] | Run a new authonly (debit) transaction for credit cards. ​  | +
-| [[developer:​soap:​methods:​runCredit|runCredit]] ​ | Run a credit transaction for credit cards. | +
-| [[developer:​soap:​methods:​runCheckSale|runCheckSale]] | Run a new sale (debit) transaction for checks. ​  | +
-| [[developer:​soap:​methods:​runCheckCredit|runCheckCredit]] ​ | Run a credit transaction for checks. | +
-| [[developer:​soap:​methods:​runQuickSale|runQuickSale]] | Run a sale based on the credit card or check details of a previous transaction. | +
-| [[developer:​soap:​methods:​runQuickCredit|runQuickCredit]] | Run a credit based on the credit card or check details of a previous transaction. | +
-| [[developer:​soap:​methods:​postAuth|postAuth]] ​  | Post an offline authorization ​ |  +
-| [[developer:​soap:​methods:​captureTransaction|captureTransaction]] ​  | Capture a queued transaction. ​ | +
-| [[developer:​soap:​methods:​refundTransaction|refundTransaction]] ​  | Refund a specific transaction. ​ | +
-| [[developer:​soap:​methods:​overrideTransaction|overrideTransaction]] ​  | Override a specific transaction. | +
-| [[developer:​soap:​methods:​voidTransaction|voidTransaction]] ​  | Void a specific transaction. | +
-| [[developer:​soap:​methods:​getTransactionStatus|getTransactionStatus]] ​ | Retrieve the current status of a specific transaction. ​  | +
-| [[developer:​soap:​methods:​getTransaction|getTransaction]] ​  | Retrieves all details of a specified transaction. | +
-| [[developer:​soap:​methods:​getTransactionCustom|getTransactionCustom]] | Retrieves only selected details of a specified transaction. | +
-| [[developer:​soap:​methods:​searchTransactions|searchTransactions]] | Search transactions and return full transaction records. ​ | +
-| [[developer:​soap:​methods:​searchTransactionsCount|searchTransactionsCount]] | Returns number of transactions that match search criteria. ​ | +
-| [[developer:​soap:​methods:​searchTransactionsCustom|searchTransactionsCustom]] | Search transactions and return only specific fields. ​ | +
-| [[developer:​soap:​methods:​getTransactionReport|getTransactionReport]] | Pull a transaction report. ​ | +
-| [[developer:​soap:​methods:​convertTranToCust|convertTranToCust]] | Convert a transaction data to a stored customer record. ​ | +
- +
- +
- +
- +
- +
-==== Bulk Transaction Uploads ==== +
- +
-| [[developer:​soap:​methods:​createBatchUpload|createBatchUpload]] | Post a new batch of transactions to the gateway for processing. | +
-| [[developer:​soap:​methods:​runBatchUpload|runBatchUpload]] | Resume processing a paused batch upload. ​ | +
-| [[developer:​soap:​methods:​pauseBatchUpload|pauseBatchUpload]] | Pause a Batch Upload that is already running. ​ | +
-| [[developer:​soap:​methods:​getBatchUploadStatus|getBatchUploadStatus]] | Retrieve the status of a currently running batch. | +
- +
- +
- +
-==== Credit Card Batches ==== +
- +
-| [[developer:​soap:​methods:​searchBatches]] | Search previously settled batches. ​  ​|  +
-| [[developer:​soap:​methods:​searchBatchesCount|searchBatchesCount]] | Returns number of batches that match search criteria. ​ | +
-| [[developer:​soap:​methods:​getBatchStatus]] | Retrieves the status of a batch specified by its BatchNum. ​  ​|  +
-| [[developer:​soap:​methods:​closeBatch]] | Close a batch specified by BatchNum. ​  ​|  +
-| [[developer:​soap:​methods:​getBatchTransactions]] | Retrieve transactions in the batch specified by BatchNum ​  ​|  +
- +
- +
- +
- +
- +
-==== Customers ==== +
- +
-| [[developer:​soap:​methods:​runCustomerTransaction|runCustomerTransaction]] | Run a transaction using payment data stored in the customer database. ​  ​|  +
-| [[developer:​soap:​methods:​enableCustomer|enableCustomer]] | Enable recurring billing for a customer specified by CustNum. ​  ​|  +
-| [[developer:​soap:​methods:​disableCustomer|disableCustomer]] | Disable the recurring billing for a customer specified by CustNum. ​  ​|  +
-| [[developer:​soap:​methods:​deleteCustomer|deleteCustomer]] | Delete the customer specified by CustNum. ​  ​|  +
-| [[developer:​soap:​methods:​searchCustomerID|searchCustomerID]] | Find a CustNum (assigned by the gateway) using a CustID (assigned by merchant). ​  ​|  +
-| [[developer:​soap:​methods:​getCustomer|getCustomer]] | Retrieve the customer details for a given CustNum. ​  ​|  +
-| [[developer:​soap:​methods:​searchCustomers|searchCustomers]] | Search customer database, returns full customer object for each customer found. ​  | +
-| [[developer:​soap:​methods:​searchCustomersCount|searchCustomersCount]] | Returns number of customers that match search criteria. ​ | +
-| [[developer:​soap:​methods:​searchCustomersCustom|searchCustomersCustom]] | Search for customers, returning custom columns. ​  |  +
-| [[developer:​soap:​methods:​getCustomerHistory|getCustomerHistory]] | Pull details of all transactions run for CustNum. ​  | +
-| [[developer:​soap:​methods:​addCustomer|addCustomer]] | Add a customer to your stored customer database. ​  |  +
-| [[developer:​soap:​methods:​addCustomerPaymentMethod|addCustomerPaymentMethod]] | Add a payment method for an existing customer. ​  | +
-| [[developer:​soap:​methods:​deleteCustomerPaymentMethod|deleteCustomerPaymentMethod]] | Delete a payment method from an existing customer. ​  | +
-| [[developer:​soap:​methods:​getCustomerPaymentMethod|getCustomerPaymentMethod]] | Retrieve a specific Customer Payment Method ​  | +
-| [[developer:​soap:​methods:​getCustomerPaymentMethods|getCustomerPaymentMethods]] | Retrieve all Customer Payment Methods for a specific Customer ​  | +
-| [[developer:​soap:​methods:​updateCustomer|updateCustomer]] | Replace all data for customer specified by CustNum. ​  | +
-| [[developer:​soap:​methods:​quickUpdateCustomer|quickUpdateCustomer]] | Update customer data in selected fields only.   | +
-| [[developer:​soap:​methods:​updateCustomerPaymentMethod|updateCustomerPaymentMethod]] | Update customer payment method specified by MethodId ​  | +
-| [[developer:​soap:​methods:​copyCustomer|copyCustomer]] | Copy customer from one merchant account to another. ​  | +
-| [[developer:​soap:​methods:​moveCustomer|moveCustomer]] | Move customer from one merchant account to another. ​  | +
- +
- +
-==== General Merchant Methods ==== +
- +
-| [[developer:​soap:​methods:​getAccountDetails|getAccountDetails]] | Retrieves information about merchant account. ​  ​|  +
-| [[developer:​soap:​methods:​getSupportedCurrencies|getSupportedCurrencies]] | Retrieves an array of currencies supported by a merchant account. ​  |  +
-| [[developer:​soap:​methods:​currencyConversion|currencyConversion]] | Find currency conversion rate for a transaction amount. ​  ​|  +
-| [[developer:​soap:​methods:​bulkCurrencyConversion|bulkCurrencyConversion]] | Converts multiple amounts in a single method call.   ​|  +
-| [[developer:​soap:​methods:​getBankList|getBankList]] | Retrieve list of banks that the merchant can accept direct payments from | +
- +
- +
-==== Reseller Methods ==== +
- +
-| [[developer:​soap:​methods:​addMerchantApplication]] | Add a new merchant application to the system. ​  ​|  +
-| [[developer:​soap:​methods:​getMerchantApplicationStatus]] | Retrieve the status of a pending merchant application. ​  ​|  +
-| [[developer:​soap:​methods:​getMerchant]] | Retrieve details of a merchant'​s account. ​  ​|  +
-| [[developer:​soap:​methods:​updateMerchant]] | Update details in a merchant'​s account. ​  ​|  +
-| [[developer:​soap:​methods:​deleteMerchant]] | Request deletion of merchant account. ​  ​|  +
-| [[developer:​soap:​methods:​searchMerchants]] | Search active merchants. ​  | +
-| [[developer:​soap:​methods:​searchMerchantsCount|searchMerchantsCount]] | Returns number of merchants that match search criteria. ​ | +
-| [[developer:​soap:​methods:​searchMerchantsCustom]] | Search active merchants, return custom columns ​  | +
-| [[developer:​soap:​methods:​getMerchantSummary]] | View summary of merchant activity. ​  | +
- +
-===== Objects ===== +
- +
-| [[developer:​soap:​objects:​AccountDetails|AccountDetails]] | Contains all relevant data pertaining to a merchant account. ​  |  +
-| [[developer:​soap:​objects:​Address|Address]] | Contains customer contact information. ​  |  +
-| [[.:​objects:​Bank]] | Describes Bank or Fincial Institution that supports direct payment processing | +
-| [[.:​objects:​BatchSearchResult]] | Batch search result object | +
-| [[developer:​soap:​objects:​BatchStatus|BatchStatus]] | Contains information about a batch awaiting settlement. ​  |  +
-| [[developer:​soap:​objects:​BatchUploadStatus|BatchUploadStatus]] | Contains information on an uploaded batch. ​  |  +
-| [[developer:​soap:​objects:​CheckData|CheckData]] | Contains information for electronic check transactions. ​  |  +
-| [[developer:​soap:​objects:​CheckTrace|CheckTrace]] | Electronic check transaction tracking data.   |  +
-| [[developer:​soap:​objects:​CreditCardData|CreditCardData]] | This object contains credit card specific information for a transaction. ​  |  +
-| [[developer:​soap:​objects:​CurrencyConversion|CurrencyConversion]] | Contains the results of a currency conversion. ​  |  +
-| [[developer:​soap:​objects:​CurrencyObject|CurrencyObject]] | Describes a currency supported by the merchant'​s account. ​  |  +
-| [[developer:​soap:​objects:​CustomerObject|CustomerObject]] | Contains customer data.   |  +
-| [[developer:​soap:​objects:​CustomerSearchResult|CustomerSearchResult]] | Contains customer search data.   | +
-| [[developer:​soap:​objects:​CustomerTransactionDetail|CustomerTransactionDetail]] | Contains transaction specific data for stored customer transactions. ​  |  +
-| [[developer:​soap:​objects:​FieldValue|FieldValue]] | Generalized Field-Value Pair   |  +
-| [[developer:​soap:​objects:​MerchantApplicationObject|MerchantApplicationObject]] | Contains information for a new merchant application. ​  |  +
-| [[developer:​soap:​objects:​MerchantObject|MerchantObject]] | Contains contact information for an active merchant. ​  |  +
-| [[developer:​soap:​objects:​MerchantSearchResult|MerchantSearchResult]] | Contains the results of a merchant search. ​  |  +
-| [[developer:​soap:​objects:​MerchantSummaryObject|MerchantSummaryObject]] | Summary of merchant activity over a given time period. ​  |  +
-| [[developer:​soap:​objects:​PaymentMethod|PaymentMethod]] | Describes a customer payment method. ​  |  +
-| [[developer:​soap:​objects:​RecurringBilling|RecurringBilling]] | This object stores information relating to specific recurring billing cycles. ​  |  +
-| [[developer:​soap:​objects:​SearchParam|SearchParam]] | Used to create a unique search parameter. ​  ​|  +
-| [[developer:​soap:​objects:​TransactionDetail|TransactionDetail]] | Contains transaction specific data.   |  +
-| [[developer:​soap:​objects:​TransactionObject|TransactionObject]] | Contains all transaction data.   |  +
-| [[developer:​soap:​objects:​TransactionRequestObject|TransactionRequestObject]] | Used to run a new transaction. ​  |  +
-| [[developer:​soap:​objects:​TransactionResponse|TransactionResponse]] | Contains details on the result of a processed transaction. ​  |  +
-| [[developer:​soap:​objects:​TransactionSearchResult|TransactionSearchResult]] | Contains results of a transaction search. ​  |  +
-| [[developer:​soap:​objects:​ueHash|ueHash]] | Defines the properties of the hash used to validate a source key.   |  +
-| [[developer:​soap:​objects:​ueSecurityToken|ueSecurityToken]] | Defines a source key used to identify a merchant or reseller. ​  |  +
- +
developer/soap/support.txt · Last modified: 2010/08/27 10:26 by tem

Page Tools