Admin Web Service

Admin

Click here for a complete list of operations.

AddMerchant

Add a merchant.

Parameters

UserName	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.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
Username:
SecureToken:
ResellerKey:
MerchantUsername:
MerchantPassword:
MerchantID:
MerchantID2:
AnnualSales:
BusinessStartDate:
CompanyName:
DoingBusinessAs:
Url:
FederalTaxID:
StateTaxID:
SalesTaxID:
OwnershipType:
AutoCloseBatch:
AutoCloseBatchHour:
ForceDuplicate:
RequirePNRef:
ContactFirstName:
ContactLastName:
ContactEmail:
ContactDayPhone:
ContactFax:
ContactStreet1:
ContactStreet2:
ContactCity:
ContactState:
ContactPostalCode:
ContactCountryCode:
TimeZoneOffset:
PaymentMethodsXml:
RegistersXml:
ExtData:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /admin/ws/admin.asmx HTTP/1.1
Host: secure.redfinnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.tpisoft.com/Admin/ws/AddMerchant"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddMerchant xmlns="http://www.tpisoft.com/Admin/ws">
      <Username>string</Username>
      <SecureToken>string</SecureToken>
      <ResellerKey>string</ResellerKey>
      <MerchantUsername>string</MerchantUsername>
      <MerchantPassword>string</MerchantPassword>
      <MerchantID>string</MerchantID>
      <MerchantID2>string</MerchantID2>
      <AnnualSales>string</AnnualSales>
      <BusinessStartDate>string</BusinessStartDate>
      <CompanyName>string</CompanyName>
      <DoingBusinessAs>string</DoingBusinessAs>
      <Url>string</Url>
      <FederalTaxID>string</FederalTaxID>
      <StateTaxID>string</StateTaxID>
      <SalesTaxID>string</SalesTaxID>
      <OwnershipType>string</OwnershipType>
      <AutoCloseBatch>string</AutoCloseBatch>
      <AutoCloseBatchHour>string</AutoCloseBatchHour>
      <ForceDuplicate>string</ForceDuplicate>
      <RequirePNRef>string</RequirePNRef>
      <ContactFirstName>string</ContactFirstName>
      <ContactLastName>string</ContactLastName>
      <ContactEmail>string</ContactEmail>
      <ContactDayPhone>string</ContactDayPhone>
      <ContactFax>string</ContactFax>
      <ContactStreet1>string</ContactStreet1>
      <ContactStreet2>string</ContactStreet2>
      <ContactCity>string</ContactCity>
      <ContactState>string</ContactState>
      <ContactPostalCode>string</ContactPostalCode>
      <ContactCountryCode>string</ContactCountryCode>
      <TimeZoneOffset>string</TimeZoneOffset>
      <PaymentMethodsXml>string</PaymentMethodsXml>
      <RegistersXml>string</RegistersXml>
      <ExtData>string</ExtData>
    </AddMerchant>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddMerchantResponse xmlns="http://www.tpisoft.com/Admin/ws">
      <AddMerchantResult>
        <code>OK or Unknown_Error or Access_Denied or Invalid_Login or Invalid_User_Status or Invalid_User or User_Not_Found or Username_Already_In_Use or Username_Has_Invalid_Characters or Not_Enough_Privilege or Invalid_PartnerID or Invalid_VendorID or Invalid_Argument or Invalid_Record or Transaction_Type_Not_Supported_By_Host or Internal_Error</code>
        <error>string</error>
        <Partner>string</Partner>
        <Vendor>string</Vendor>
        <Username>string</Username>
      </AddMerchantResult>
    </AddMerchantResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /admin/ws/admin.asmx/AddMerchant?Username=string&SecureToken=string&ResellerKey=string&MerchantUsername=string&MerchantPassword=string&MerchantID=string&MerchantID2=string&AnnualSales=string&BusinessStartDate=string&CompanyName=string&DoingBusinessAs=string&Url=string&FederalTaxID=string&StateTaxID=string&SalesTaxID=string&OwnershipType=string&AutoCloseBatch=string&AutoCloseBatchHour=string&ForceDuplicate=string&RequirePNRef=string&ContactFirstName=string&ContactLastName=string&ContactEmail=string&ContactDayPhone=string&ContactFax=string&ContactStreet1=string&ContactStreet2=string&ContactCity=string&ContactState=string&ContactPostalCode=string&ContactCountryCode=string&TimeZoneOffset=string&PaymentMethodsXml=string&RegistersXml=string&ExtData=string HTTP/1.1
Host: secure.redfinnet.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Result xmlns="http://www.tpisoft.com/Admin/ws">
  <code>OK or Unknown_Error or Access_Denied or Invalid_Login or Invalid_User_Status or Invalid_User or User_Not_Found or Username_Already_In_Use or Username_Has_Invalid_Characters or Not_Enough_Privilege or Invalid_PartnerID or Invalid_VendorID or Invalid_Argument or Invalid_Record or Transaction_Type_Not_Supported_By_Host or Internal_Error</code>
  <error>string</error>
  <Partner>string</Partner>
  <Vendor>string</Vendor>
  <Username>string</Username>
</Result>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /admin/ws/admin.asmx/AddMerchant HTTP/1.1
Host: secure.redfinnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&SecureToken=string&ResellerKey=string&MerchantUsername=string&MerchantPassword=string&MerchantID=string&MerchantID2=string&AnnualSales=string&BusinessStartDate=string&CompanyName=string&DoingBusinessAs=string&Url=string&FederalTaxID=string&StateTaxID=string&SalesTaxID=string&OwnershipType=string&AutoCloseBatch=string&AutoCloseBatchHour=string&ForceDuplicate=string&RequirePNRef=string&ContactFirstName=string&ContactLastName=string&ContactEmail=string&ContactDayPhone=string&ContactFax=string&ContactStreet1=string&ContactStreet2=string&ContactCity=string&ContactState=string&ContactPostalCode=string&ContactCountryCode=string&TimeZoneOffset=string&PaymentMethodsXml=string&RegistersXml=string&ExtData=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Result xmlns="http://www.tpisoft.com/Admin/ws">
  <code>OK or Unknown_Error or Access_Denied or Invalid_Login or Invalid_User_Status or Invalid_User or User_Not_Found or Username_Already_In_Use or Username_Has_Invalid_Characters or Not_Enough_Privilege or Invalid_PartnerID or Invalid_VendorID or Invalid_Argument or Invalid_Record or Transaction_Type_Not_Supported_By_Host or Internal_Error</code>
  <error>string</error>
  <Partner>string</Partner>
  <Vendor>string</Vendor>
  <Username>string</Username>
</Result>