BusinessInfo

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  BusinessInfo
Represents fields reflecting business information for a merchant.
legalName
References: Business Info.Legal Name
XML Representation: attribute
Attributes:
Default Value
Pattern: NAME_BUSINESS
The legal name of the company.
webSite
References: Business Info.WEB Site
XML Representation: attribute
Attributes:
Default Value
Pattern: URL
URL of the corporate website of the company.
federalTaxId
References: Business Info.Federal Tax ID
XML Representation: attribute
Attributes:
Default Value
Pattern: NUMERIC
Federal Tax identifier of the company.
stateTaxId
References: Business Info.State Tax ID
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHANUMERIC_EXTENDED
State Tax identifier of the company.
salesTaxId
References: Business Info.Sale Tax ID
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHANUMERIC_EXTENDED
Sale Tax identifier of the company.
ownershipStructureType
References: Business Info.Ownership Structure CL
XML Representation: attribute
Attributes:
Default Value
Enumeration of possible ownership types of the company.
estimatedTransactionVolume
References: Business Info.Estimated Transaction Volume
XML Representation: attribute
Attributes:
Default Value
The estimated volume of transactions expected to be processed during the indicated estimation period.
estimatedAvgTransactionAmount
References: Business Info.Estimated AVG Transaction Amount
XML Representation: attribute
Attributes:
Default Value
The estimated average amount of transactions expected to be processed during the indicated estimation period.
estimatedMaxTransactionAmount
References: Business Info.Estimated MAX Transaction Amount
XML Representation: attribute
Attributes:
Default Value
estimationPeriodType
References: Business Info.Estimation Period CL
XML Representation: attribute
Attributes:
Default Value
Enumeration of possible time periods for which transaction volume and average transaction amount are defined.
relationshipBeginDate
References: Business Info.Relationship Begin Date
XML Representation: attribute
Attributes:
Default Value
Date when the business relationship with this company was officially established.
currencyCode
References: Business Info.Currency Code
XML Representation: attribute
Attributes:
Default Value
The code of currency which the company processes transactions in.
createDate
References: Business Info.Create Date
XML Representation: attribute
Attributes:
Default Value
Date when the record was created.
street1
References: Business Info.Street1
XML Representation: attribute
Attributes:
Default Value
Pattern: STREET
Street1 of a company's mailing address.
street2
References: Business Info.Street2
XML Representation: attribute
Attributes:
Default Value
Pattern: STREET
Street2 of a company's mailing address.
city
References: Business Info.City
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHANUMERIC_EXTENDED
City name of a company's mailing address.
state
References: Business Info.State
XML Representation: attribute
Attributes:
Default Value
State of a company's mailing address.
zipCode
References: Business Info.ZIP Code
XML Representation: attribute
Attributes:
Default Value
ZIP code of a company's mailing address.
countryCode
References: Business Info.Country Code
XML Representation: attribute
Attributes:
Default Value
Country code of a company's mailing address.
businessName
References: Business Info.Business Name
XML Representation: attribute
Attributes:
Default Value
Pattern: NAME_BUSINESS
The DBA ("doing business as") name.
registrationYear
References: Business Info.Registration Year
XML Representation: attribute
Attributes:
Default Value
The year when the merchant's business was established.
registrationCountryCode
References: Business Info.Registration Country Code
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHA
The country where the merchant's business was established.
registrationState
References: Business Info.Registration State
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHA
The state where the merchant's business was established.
email
References: Business Info.Email
XML Representation: attribute
Attributes:
Default Value
Pattern: EMAIL
Email address of a company.
workHours
References: Business Info.Work Hours
XML Representation: attribute
Attributes:
Default Value
Pattern: TEXT
Working hours of the company.
customerServicePhone
References: Business Info.Customer Service Phone
XML Representation: attribute
Attributes:
Default Value
Pattern: NUMERIC
Phone number of the customer service.
contractBeginDate
References: Business Info.Contract Begin Date
XML Representation: attribute
Attributes:
Default Value
contractEndDate
References: Business Info.Contract End Date
XML Representation: attribute
Attributes:
Default Value
address
References: Business Info.Address
XML Representation: attribute
Attributes: ReadOnly, Calculated
Default Value
Address associated with a payment card or bank account holder. The value is a concatenation of the street1, street2, city, state, zipCode, countryCode field values separated by commas (,).
cardDescriptor
References: Business Info.Card Descriptor
XML Representation: attribute
Attributes:
Default Value
The desired description for transactions when they appear on the banking statement of a customer.

XML Sample:

<business-info
    legalName="John Smith Consulting, LLC-A" 
    webSite="https://www.example.com" 
    federalTaxId="1234567890" 
    stateTaxId="00-0000000" 
    salesTaxId="VAT" 
    ownershipStructureType="LLC" 
    estimatedTransactionVolume="400" 
    estimatedAvgTransactionAmount="50" 
    estimatedMaxTransactionAmount="50" 
    estimationPeriodType="M" 
    relationshipBeginDate="2012-01-01" 
    currencyCode="US" 
    createDate="2012-01-01" 
    street1="12 Main St" 
    street2="Suite #3" 
    city="Denver" 
    state="CO" 
    zipCode="80201" 
    countryCode="US" 
    businessName="Sample Merchant Ltd." 
    registrationYear="2013" 
    registrationCountryCode="US" 
    registrationState="CO" 
    email="test@test.com" 
    workHours="8-22" 
    customerServicePhone="123456789" />

"<business-info legalName=\"John Smith Consulting, LLC-A\" webSite=\"https://www.example.com\" federalTaxId=\"1234567890\" stateTaxId=\"00-0000000\" salesTaxId=\"VAT\" ownershipStructureType=\"LLC\" estimatedTransactionVolume=\"400\" estimatedAvgTransactionAmount=\"50\" estimatedMaxTransactionAmount=\"50\" estimationPeriodType=\"M\" relationshipBeginDate=\"2012-01-01\" currencyCode=\"US\" createDate=\"2012-01-01\" street1=\"12 Main St\" street2=\"Suite #3\" city=\"Denver\" state=\"CO\" zipCode=\"80201\" countryCode=\"US\" businessName=\"Sample Merchant Ltd.\" registrationYear=\"2013\" registrationCountryCode=\"US\" registrationState=\"CO\" email=\"test@test.com\" workHours=\"8-22\" customerServicePhone=\"123456789\" />"

JSON Sample:

{
  "legalName": "John Smith Consulting, LLC-A",
  "webSite": "https:\/\/www.example.com",
  "federalTaxId": "1234567890",
  "stateTaxId": "00-0000000",
  "salesTaxId": "VAT",
  "ownershipStructureType": "LLC",
  "estimatedTransactionVolume": "400",
  "estimatedAvgTransactionAmount": "50",
  "estimatedMaxTransactionAmount": "50",
  "estimationPeriodType": "M",
  "relationshipBeginDate": "2012-01-01",
  "currencyCode": "US",
  "createDate": "2012-01-01",
  "street1": "12 Main St",
  "street2": "Suite #3",
  "city": "Denver",
  "state": "CO",
  "zipCode": "80201",
  "countryCode": "US",
  "businessName": "Sample Merchant Ltd.",
  "registrationYear": "2013",
  "registrationCountryCode": "US",
  "registrationState": "CO",
  "email": "test@test.com",
  "workHours": "8-22",
  "customerServicePhone": "123456789"
}

XURL Sample:

?legalName=John+Smith+Consulting%2C+LLC-A&webSite=https%3A%2F%2Fwww.example.com&federalTaxId=1234567890&stateTaxId=00-0000000&salesTaxId=VAT&ownershipStructureType=LLC&estimatedTransactionVolume=400&estimatedAvgTransactionAmount=50&estimatedMaxTransactionAmount=50&estimationPeriodType=M&relationshipBeginDate=2012-01-01&currencyCode=US&createDate=2012-01-01&street1=12+Main+St&street2=Suite+%233&city=Denver&state=CO&zipCode=80201&countryCode=US&businessName=Sample+Merchant+Ltd.&registrationYear=2013&registrationCountryCode=US&registrationState=CO&email=test%40test.com&workHours=8-22&customerServicePhone=123456789&
legalName=John Smith Consulting, LLC-A
webSite=https://www.example.com
federalTaxId=1234567890
stateTaxId=00-0000000
salesTaxId=VAT
ownershipStructureType=LLC
estimatedTransactionVolume=400
estimatedAvgTransactionAmount=50
estimatedMaxTransactionAmount=50
estimationPeriodType=M
relationshipBeginDate=2012-01-01
currencyCode=US
createDate=2012-01-01
street1=12 Main St
street2=Suite #3
city=Denver
state=CO
zipCode=80201
countryCode=US
businessName=Sample Merchant Ltd.
registrationYear=2013
registrationCountryCode=US
registrationState=CO
email=test@test.com
workHours=8-22
customerServicePhone=123456789