Merchant

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  Merchant
Represents merchant object without sub-components
Available Fields:
id
References: Merchant.Code
XML Representation: attribute
Attributes: Unique, Required, CreateOnly
Default Value
Unique identifier of the merchant generated by the gateway.
code
References: Merchant.Ref Code
XML Representation: attribute
Attributes: Unique, CreateOnly
Default Value
Optional identifier of the Merchant that can be used to cross-reference the Merchant record between multiple systems.

See Reference Code definition for additional information.
name
References: Merchant.Name
XML Representation: attribute
Attributes: Required
Default Value
Pattern: NAME_BUSINESS
The DBA name of the merchant.
createDate
References: Merchant.Create Date
XML Representation: attribute
Attributes:
Default Value
Date when the record was created.
isActive
References: Merchant.Is Active
XML Representation: attribute
Attributes:
Default Value true
Indicates whether the record is active and can process through the system.
password
References: Merchant.Processing Password
XML Representation: attribute
Attributes:
Default Value
Pattern: PASSWORD
Merchant's password for transaction processing API. This value in combination with Merchant Code serves as a set of credentials to authenticate the submitter of a transaction.
timeZone
References: Merchant.Time Zone Code
XML Representation: attribute
Attributes:
Default Value
Time zone of a merchant.
notes
References: Merchant.Notes
XML Representation: element
Attributes:
Default Value
Provides a place to store short generic notes about the merchant.
merchantType
Type: String
XML Representation: attribute
Attributes:
Default Value
Type of a merchant profile.
portfolioCode
Type: Integer
XML Representation: attribute
Attributes:
Default Value
deactivateDate
References: Merchant.Deactivate Date
XML Representation: attribute
Attributes:
Default Value
Date when the record was deactivated.
multipleAccounts
Type: Boolean
XML Representation: attribute
Attributes: Required
Default Value
multipleTaxIds
Type: Boolean
XML Representation: attribute
Attributes: Required
Default Value
multipleDescriptors
Type: Boolean
XML Representation: attribute
Attributes: Required
Default Value
multipleDepositAccounts
Type: Boolean
XML Representation: attribute
Attributes: Required
Default Value
multipleRecurringFees
Type: Boolean
XML Representation: attribute
Attributes: Required
Default Value
feeProcessorCode
Type: Integer
XML Representation: attribute
Attributes:
Default Value
directoryCode
References: Merchant.Directory Code
XML Representation: attribute
Attributes:
Default Value
Specific identifier assigned for a merchant.
countryCode
References: Merchant.Country Code
XML Representation: attribute
Attributes: Required
Default Value
Country code of the merchant.
tagList
Type: String(50)
XML Representation: attribute
Attributes:
Default Value
tags for options
resellerCode
Type: Integer(50)
XML Representation: attribute
Attributes:
Default Value
remitterCode
Type: Integer
XML Representation: attribute
Attributes:
Default Value

XML Sample:

<merchants>
     <merchant
         id="2000" 
         code="908 303" 
         name="Sample Merchant" 
         isActive="true" 
         password="samplePassword" 
         timeZone="EST" >
         <notes>Some sample notes about the merchant</notes>
         merchantType="merchant" 
         portfolioCode="100" 
         deactivateDate="2014-12-31" 
         multipleAccounts="true" 
         multipleTaxIds="true" 
         multipleDescriptors="true" 
         multipleDepositAccounts="true" 
         multipleRecurringFees="true" 
         feeProcessorCode="100" 
         countryCode="US" 
         tagList="#merchantAccountCode" 
         resellerCode="1" 
     </merchant>
</merchants>
"<merchants> <merchant id=\"2000\" code=\"908 303\" name=\"Sample Merchant\" isActive=\"true\" password=\"samplePassword\" timeZone=\"EST\" > <notes>Some sample notes about the merchant</notes> merchantType=\"merchant\" portfolioCode=\"100\" deactivateDate=\"2014-12-31\" multipleAccounts=\"true\" multipleTaxIds=\"true\" multipleDescriptors=\"true\" multipleDepositAccounts=\"true\" multipleRecurringFees=\"true\" feeProcessorCode=\"100\" countryCode=\"US\" tagList=\"#merchantAccountCode\" resellerCode=\"1\" </merchant></merchants>"

JSON Sample:

{
  "id": 2000,
  "code": "908 303",
  "name": "Sample Merchant",
  "isActive": true,
  "password": "samplePassword",
  "timeZone": "EST",
  "notes": "Some sample notes about the merchant",
  "merchantType": "merchant",
  "portfolioCode": 100,
  "deactivateDate": "2014-12-31",
  "multipleAccounts": true,
  "multipleTaxIds": true,
  "multipleDescriptors": true,
  "multipleDepositAccounts": true,
  "multipleRecurringFees": true,
  "feeProcessorCode": 100,
  "countryCode": "US",
  "tagList": "#merchantAccountCode",
  "resellerCode": 1
}

XURL Sample:

?id=2000&code=908+303&name=Sample+Merchant&isActive=true&password=samplePassword&timeZone=EST&notes=Some+sample+notes+about+the+merchant&merchantType=merchant&portfolioCode=100&deactivateDate=2014-12-31&multipleAccounts=true&multipleTaxIds=true&multipleDescriptors=true&multipleDepositAccounts=true&multipleRecurringFees=true&feeProcessorCode=100&countryCode=US&tagList=%23merchantAccountCode&resellerCode=1&
id=2000
code=908 303
name=Sample Merchant
isActive=true
password=samplePassword
timeZone=EST
notes=Some sample notes about the merchant
merchantType=merchant
portfolioCode=100
deactivateDate=2014-12-31
multipleAccounts=true
multipleTaxIds=true
multipleDescriptors=true
multipleDepositAccounts=true
multipleRecurringFees=true
feeProcessorCode=100
countryCode=US
tagList=#merchantAccountCode
resellerCode=1
Copyright © United Thinkers. (UniPay - Payment Gateway Software)
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.