MerchantFacade

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  MerchantFacade
Represents merchant object with all sub-components
code
References: Merchant.Code
XML Representation: attribute
Attributes: Unique, Required, CreateOnly
Default Value
Unique identifier of the merchant generated by the gateway.
referenceCode
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
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.
notes
References: Merchant.Notes
XML Representation: element
Attributes:
Default Value
Provides a place to store short generic notes about the merchant.
phases
XML Representation: element
Attributes:
Default Value
contactInfo
XML Representation: element
Attributes:
Default Value
letters
XML Representation: element
Attributes:
Default Value

XML Sample:

<merchant code="2000"  referenceCode="908 303"  name="Sample Merchant"  createDate="2012-04-01"  isActive="true" >
    <notes>Some sample notes about the merchant</notes>
    <phases phase2Age="30"  phase3Age="60"  phase4Age="90" />
    <contactInfo contactName="John Smith"  street1="11 Broadway"  street2="Suite #3"  city="New York"  state="NY"  zipCode="10001"  phone="1234567890"  fax="1234567890"  email="john.smith@samplemerchant.com"  countryCode="US" />
    <letters
        welcomeCode="welcomeCode" 
        softDeclineCode="softDeclineCode" 
        softDeclineIsStatement="true" 
        softDeclineWaitPeriod="1" 
        softDeclineIsBalanceRequired="true" 
        hardDeclineCode="hardDeclineCode" 
        hardDeclineIsStatement="true" 
        chargebackCode="chargebackCode" 
        chargebackIsStatement="true" 
        statementCode="statementCode" 
        collections1Code="collections1Code" 
        collections2Code="collections2Code" 
        collections3Code="collections3Code" 
        collections4Code="collections4Code" 
        collections5Code="collections5Code" 
        collections1Age="1" 
        collections2Age="2" 
        collections3Age="3" 
        collections4Age="4" 
        collections5Age="5" 
        invoiceCode="invoiceCode" 
        invoicePeriod="0" 
        notification1Code="notification1Code" 
        notification2Code="notification2Code" 
        notification3Code="notification3Code" 
        notification1Age="1" 
        notification2Age="2" 
        notification3Age="3" 
        newField2="" />
</merchant>

JSON Sample:

{
  "code": 2000,
  "referenceCode": "908 303",
  "name": "Sample Merchant",
  "createDate": "2012-04-01",
  "isActive": true,
  "notes": "Some sample notes about the merchant",
  "phases": {
    "phase2Age": 30,
    "phase3Age": 60,
    "phase4Age": 90
  },
  "contactInfo": {
    "contactName": "John Smith",
    "street1": "11 Broadway",
    "street2": "Suite #3",
    "city": "New York",
    "state": "NY",
    "zipCode": 10001,
    "phone": "1234567890",
    "fax": "1234567890",
    "email": "john.smith@samplemerchant.com",
    "countryCode": "US"
  },
  "letters": {
    "welcomeCode": "welcomeCode",
    "softDeclineCode": "softDeclineCode",
    "softDeclineIsStatement": true,
    "softDeclineWaitPeriod": 1,
    "softDeclineIsBalanceRequired": true,
    "hardDeclineCode": "hardDeclineCode",
    "hardDeclineIsStatement": true,
    "chargebackCode": "chargebackCode",
    "chargebackIsStatement": true,
    "statementCode": "statementCode",
    "collections1Code": "collections1Code",
    "collections2Code": "collections2Code",
    "collections3Code": "collections3Code",
    "collections4Code": "collections4Code",
    "collections5Code": "collections5Code",
    "collections1Age": 1,
    "collections2Age": 2,
    "collections3Age": 3,
    "collections4Age": 4,
    "collections5Age": 5,
    "invoiceCode": "invoiceCode",
    "invoicePeriod": 0,
    "notification1Code": "notification1Code",
    "notification2Code": "notification2Code",
    "notification3Code": "notification3Code",
    "notification1Age": 1,
    "notification2Age": 2,
    "notification3Age": 3,
    "newField2": ""
  }
}

XURL Sample:

code=2000
referenceCode=908 303
name=Sample Merchant
createDate=2012-04-01
isActive=true
notes=Some sample notes about the merchant
phases.phase2Age=30
phases.phase3Age=60
phases.phase4Age=90
contactInfo.contactName=John Smith
contactInfo.street1=11 Broadway
contactInfo.street2=Suite #3
contactInfo.city=New York
contactInfo.state=NY
contactInfo.zipCode=10001
contactInfo.phone=1234567890
contactInfo.fax=1234567890
contactInfo.email=john.smith@samplemerchant.com
contactInfo.countryCode=US
letters.welcomeCode=welcomeCode
letters.softDeclineCode=softDeclineCode
letters.softDeclineIsStatement=true
letters.softDeclineWaitPeriod=1
letters.softDeclineIsBalanceRequired=true
letters.hardDeclineCode=hardDeclineCode
letters.hardDeclineIsStatement=true
letters.chargebackCode=chargebackCode
letters.chargebackIsStatement=true
letters.statementCode=statementCode
letters.collections1Code=collections1Code
letters.collections2Code=collections2Code
letters.collections3Code=collections3Code
letters.collections4Code=collections4Code
letters.collections5Code=collections5Code
letters.collections1Age=1
letters.collections2Age=2
letters.collections3Age=3
letters.collections4Age=4
letters.collections5Age=5
letters.invoiceCode=invoiceCode
letters.invoicePeriod=0
letters.notification1Code=notification1Code
letters.notification2Code=notification2Code
letters.notification3Code=notification3Code
letters.notification1Age=1
letters.notification2Age=2
letters.notification3Age=3
letters.newField2=