Admin
This Web Service provides methods that manages accounts for users, merchants and resellers.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddMerchant
Add a merchant.
ParametersUserName User name assigned in the payment server. (Required) SecureToken The users secure code. (Required) ResellerKey The key of the reseller under which the merchant is added. (Optional) MerchantUsername User name for the merchant assigned in the payment server. (Required) MerchantPassword Password for the merchant name assigned in the payment server. (Required) MerchantID ID for the merchant. (Optional) MerchantID2 ID for a second merchant. (Optional) AnnualSales Total dollar annual sales amount. (Optional) BusinessStartDate The business start date. mm/dd/yy (Optional) CompanyName The company's full name. (Optional) DoingBusinessAs Type of company (ex: retail). (Optional) Url URL of the company website. (Optional) FederalTaxID The federal tax ID. (Optional) StateTaxID The state tax ID. (Optional) SalesTaxID The sales tax ID. (Optional) OwnershipType The type of company the merchant belongs to (Ex: corporation) (Optional) AutoCloseBatch (True or False) Set the close batch automation. (Required) AutoCloseBatchHour Set the close batch time. (Required) ForceDuplicate (True or False) Allows duplicate transaction. (Required) RequirePNRef (True or False) The unique reference number assigned by the payment server to the transaction. (Required) ContactFirstName First name of the contact person. (Required) ContactLastName Last name of the contact person. (Required) ContactEmail Email address of the contact person. (Required) ContactDayPhone Day time phone number of the contact person. (Required) ContactFax Fax number of the contact person. (Optional) ContactStreet1 Line one of the of the contact person’s street address. (Required) ContactStreet2 Line two of the of the contact person’s street address. (Optional) ContactCity Contact person’s city. (Required) ContactState Contact person’s state. (Required) ContactPostalCode Contact person’s zip code. (Required) ContactCountryCode Contact person’s country. (Optional) TimeZoneOffset The time zone offset is the time zone where the merchant account is located. (Optional) PaymentMethodXml Extended data in XML format. (Required) RegistersXml Extended data in XML format. (Optional) ExtData Extended data in XML format. (Optional) Returns
The info such as the partner key and vendor key of the newly added merchant if the call is successful. - DeleteMerchant
-
InfoContract
Retrieves configuration for the specified merchant.
ParametersUsername The login username. SecureToken The login token. CustomerKey [customer_t].[customer_key] value in the SQL database. ExtData Reserved for future use. Returns
The customers contract information. -
InfoCustomer
Retrieves configuration for the specified merchant.
ParametersUsername The login username. SecureToken The login token. CustomerKey [customer_t].[customer_key] value in the SQL database. ExtData Reserved for future use. Returns
The customers information. -
InfoMerchant
Retrieves configuration for the specified merchant.
ParametersUsername The login username. SecureToken The login token. VendorKey [merchant_t].[merchant_key] value in the SQL database. ExtData Reserved for future use. Returns
The merchants configuration information. - InfoUser
-
Login
If login is successful, returns OK.
ParametersUsername The login username. Password The login password. Returns
The message status. - UpdateMerchant
- UpdateUser