developer:resellerapi

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
developer:resellerapi [2010/06/01 09:54]
tem removed
developer:resellerapi [2010/06/01 10:02] (current)
tem created
Line 1: Line 1:
-====== Reseller API v1.3 Documentation ====== +<​embed ​developer:resellerapi:Support/>​
- +
-The USAePay Reseller API provides a standardized web services interface that allows resellers to leverage some of the reseller console functionality within their applications. ​ It supports basic operations such adding new merchants to the gateway and retrieving usage reports. ​ 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 obtain a wsdl for the Reseller API,  please contact the Integration Support department. +
- +
-**Current Version: ** 1.3  +
- +
-Prior to version 1.3,  the reseller api was combined with the [[developer:soap|general merchant soap api]]. +
- +
-===== Methods ===== +
- +
-| [[.:methods:​addMerchantApplication]] | Add a new merchant application to the system. ​  ​|  +
-| [[.:​methods:​getMerchantApplicationStatus]] | Retrieve the status of a pending merchant application. ​  ​|  +
-| [[.:​methods:​getMerchant]] | Retrieve details of a merchant'​s account. ​  ​|  +
-| [[.:​methods:​updateMerchant]] | Update details in a merchant'​s account. ​  ​|  +
-| [[.:​methods:​deleteMerchant]] | Request deletion of merchant account. ​  ​|  +
-| [[.:​methods:​searchMerchants]] | Search active merchants. ​  | +
-| [[.:​methods:​searchMerchantsCount|searchMerchantsCount]] | Returns number of merchants that match search criteria. ​ | +
-| [[.:​methods:​searchMerchantsCustom]] | Search active merchants, return custom columns ​  | +
-| [[.:​methods:​getMerchantSummary]] | View summary of merchant activity. ​  | +
- +
-===== Objects ===== +
- +
-| [[.:​objects:​Address|Address]] | Contains customer contact information. ​  |  +
-| [[.:​objects:​FieldValue|FieldValue]] | Generalized Field-Value Pair   |  +
-| [[.:​objects:​MerchantApplicationObject|MerchantApplicationObject]] | Contains information for a new merchant application. ​  |  +
-| [[.:​objects:​MerchantObject|MerchantObject]] | Contains contact information for an active merchant. ​  |  +
-| [[.:​objects:​MerchantSearchResult|MerchantSearchResult]] | Contains the results of a merchant search. ​  |  +
-| [[.:​objects:​MerchantSummaryObject|MerchantSummaryObject]] | Summary of merchant activity over a given time period. ​  |  +
-| [[.:​objects:​SearchParam|SearchParam]] | Used to create a unique search parameter. ​  ​|  +
-| [[.:​objects:​ueHash|ueHash]] | Defines the properties of the hash used to validate a source key.   |  +
-| [[.:​objects:​ueSecurityToken|ueSecurityToken]] | Defines a source key used to identify a reseller. ​  |  +
developer/resellerapi.txt · Last modified: 2010/06/01 10:02 by tem

Page Tools