HeartlandCardsRealtimeProviderProfile

Type:  Struct
Abstract:  no
Status:  Active
Configuration settings for cards realtime processing through Heartland.
Avalible Field Groups:
type
Group: System
SubGroup:
Type: String(60)
XML Representation: attribute
References: Processing Profile.Type
Attributes: Constant, Required, Default: cards-realtime/heartland-exchange
Default Value: cards-realtime/heartland-exchange
Type of the Provider Profile.

Type of the Provider Profile.
isActive
Group: System
SubGroup:
Type: Boolean
XML Representation: attribute
References: Processing Profile.Is Active
Attributes: Default: true
Default Value: true
Indicates whether the record is active in the system.
accountProcessingPolicy
Group: System
SubGroup:
Type: String(10)
XML Representation: attribute
References: Processing Profile.Account Processing Policy
Attributes: Required, Default: VMXD——*U
Default Value: VMXD——*U
Type of processing policy for the account.
authorizationExpirationPeriod
Group: System
SubGroup:
Type: Integer
XML Representation: attribute
References: Retail Profile.Authorization Expiration Period
Attributes: Default: 1
Default Value: 1
The number of days from the transaction request day that the unconfirmed authorization can remain unreversed even if settlement process occurs. When settlement happens and the transaction authorization period is not being reached (transaction is not expired), transaction is transfered into the next retail cycle.
developerId
Group: Payment Facilitator
SubGroup:
Type: String(6)
XML Representation: attribute
References: Retail TSYS Profile.Developer ID
Attributes: Required, Default: 123456
Default Value: 123456
Pattern: NUMERIC
Provides a unique value to identify transactions originated by the Developer. This number is provided by TSYS Acquiring Solutions during certification.
versionId
Group: Payment Facilitator
SubGroup:
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Version ID
Attributes: Required, Default: 1295
Default Value: 1295
Pattern: ALPHANUMERIC
The Version ID provides a unique value to identify the version of software. This number is provided by TSYS Acquiring Solutions during certification.
merchantName
Group: Merchant
SubGroup: General
Type: String(25)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Name
Attributes: Required, Default: IniPay Gateway
Default Value: IniPay Gateway
Pattern: NAME
Contains the merchant name provided by the signing member or processor. Must contain the same data used in the data capture batch.
acquirerBin
Group: Merchant
SubGroup: General
Type: String(6)
XML Representation: attribute
References: Retail TSYS Profile.Acquirer BIN
Attributes: Required, Default: 123456
Default Value: 123456
Pattern: NUMERIC
Contains Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application.
agentBankNumber
Group: Merchant
SubGroup: General
Type: String(6)
XML Representation: attribute
References: Retail TSYS Profile.Agent Bank Number
Attributes: Required, Default: 123456
Default Value: 123456
Pattern: NUMERIC
Assigned by the signing member or processor. The number identifies an institution which signs merchants as an agent of a member. The member uses this number to identify the agent within TSYS Acquiring Solutions’ system.
agentChainNumber
Group: Merchant
SubGroup: General
Type: String(6)
XML Representation: attribute
References: Retail TSYS Profile.Agent Chain Number
Attributes: Required, Default: 123456
Default Value: 123456
Pattern: NUMERIC
Assigned by the signing member or processor. The member uses this number to identify the merchant chain within the TSYS Acquiring Solutions’ system.
storeNumber
Group: Merchant
SubGroup: General
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Store Number
Attributes: Required, Default: 1295
Default Value: 1295
Pattern: NUMERIC
Contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the TSYS Acquiring Solutions’ system.
terminalId    
Group: Merchant
SubGroup: General
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Terminal Number
Attributes: Required, Default: 9999
Default Value: 9999
Pattern: NUMERIC
Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Terminal override field.
timeZone
Group: Merchant
SubGroup: Address
Type: String(10)
XML Representation: attribute
References: Retail TSYS Profile.Time Zone Code
Attributes: Required, Default: EST
Default Value: EST
cityCode
Group: Merchant
SubGroup: Address
Type: String(9)
XML Representation: attribute
References: Retail TSYS Profile.City Code
Attributes: Required, Default: 586549513
Default Value: 586549513
Code used to further identify the merchant location.
city
Group: Merchant
SubGroup: Address
Type: String(13)
XML Representation: attribute
References: Retail TSYS Profile.Merchant City
Attributes: Required, Default: NEW YORK CITY
Default Value: NEW YORK CITY
Pattern: ALPHANUMERIC_EXTENDED
Contains the merchant location/city name provided by the signing member or processor. The name provided must correspond to the location/city name printed on the customer receipt.
state
Group: Merchant
SubGroup: Address
Type: String(2)
XML Representation: attribute
References: Retail TSYS Profile.Merchant State
Attributes: Required, Default: NY
Default Value: NY
Contains the merchant State/Province Code provided by the signing member or processor. Must contain the same data used in the data capture batch.
contactPhone
Group: Merchant
SubGroup: Descriptor
Type: String(10)
XML Representation: attribute
References: Retail TSYS Profile.Contact Phone Number
Attributes: Required, Default: 1047474859
Default Value: 1047474859
Pattern: NUMERIC
Phone number of the contact person
merchantNumberRetail
Group: Settings
SubGroup: Retail
Type: String(12)
XML Representation: attribute
References: Retail TSYS Profile.Retail Merchant Number
Attributes: Default: 000123852456
Default Value: 000123852456
Pattern: NUMERIC
Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system.
terminalIdNumberRetail    
Group: Settings
SubGroup: Retail
Type: String(8)
XML Representation: attribute
References: Retail TSYS Profile.Retail Terminal ID Number
Attributes: Default: 00025789
Default Value: 00025789
Pattern: NUMERIC
Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Terminal override field.
merchantCategoryCodeRetail
Group: Settings
SubGroup: Retail
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Retail Merchant Category Code
Attributes: Default: 5569
Default Value: 5569
Pattern: NUMERIC
Contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
merchantNumberMoto
Group: Settings
SubGroup: MOTO
Type: String(12)
XML Representation: attribute
References: Retail TSYS Profile.Moto Merchant Number
Attributes: Default: 000321854963
Default Value: 000321854963
Pattern: NUMERIC
Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system.
terminalIdNumberMoto    
Group: Settings
SubGroup: MOTO
Type: String(8)
XML Representation: attribute
References: Retail TSYS Profile.Moto Terminal ID Number
Attributes: Default: 00046933
Default Value: 00046933
Pattern: NUMERIC
Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Terminal override field.
merchantCategoryCodeMoto
Group: Settings
SubGroup: MOTO
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Moto Merchant Category Code
Attributes: Default: 6459
Default Value: 6459
Pattern: NUMERIC
Contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
merchantNumberEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(12)
XML Representation: attribute
References: Retail TSYS Profile.Ecommerce Merchant Number
Attributes: Default: 000658742123
Default Value: 000658742123
Pattern: NUMERIC
Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system.
terminalIdNumberEcommerce    
Group: Settings
SubGroup: eCommerce
Type: String(8)
XML Representation: attribute
References: Retail TSYS Profile.Ecommerce Terminal ID Number
Attributes: Default: 00048564
Default Value: 00048564
Pattern: NUMERIC
Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Terminal override field.
merchantCategoryCodeEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Ecommerce Merchant Category Code
Attributes: Default: 9548
Default Value: 9548
Pattern: NUMERIC
Contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
merchantNumberRestaurant
Group: Settings
SubGroup: Restaurant
Type: String(12)
XML Representation: attribute
References: Retail TSYS Profile.Restaurant Merchant Number
Attributes: Default: 000123852456
Default Value: 000123852456
Pattern: NUMERIC
Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system.
terminalIdNumberRestaurant    
Group: Settings
SubGroup: Restaurant
Type: String(8)
XML Representation: attribute
References: Retail TSYS Profile.Restaurant Terminal ID Number
Attributes: Default: 00046987
Default Value: 00046987
Pattern: NUMERIC
Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Terminal override field.
merchantCategoryCodeRestaurant
Group: Settings
SubGroup: Restaurant
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Restaurant Merchant Category Code
Attributes: Default: 6459
Default Value: 6459
Pattern: NUMERIC
Contains a number assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
connectionType
Group: Authorization
SubGroup:
Type: String
XML Representation: attribute
References: Provider Account.Primary Connection Type
Attributes: Constant, Default: Heartland
Default Value: Heartland
Type of connectivity to use to exchange messages/files with a processor.
host
Group: Authorization
SubGroup:
Type: String(100)
XML Representation: attribute
References: Provider Account.Http Host
Attributes: Required, Default: heartland.retail.net
Default Value: heartland.retail.net
Pattern: URL
Host to be used for HTTPs based connectivity.
port
Group: Authorization
SubGroup:
Type: Integer
XML Representation: attribute
References: Provider Account.HTTP Port
Attributes: Required, Default: 12351
Default Value: 12351
Port to be used for HTTPs based connectivity.
creditProcessingMode
Group: System
SubGroup:
Type: Enum
XML Representation: attribute
References: Retail Profile.Supported Credit Policy Cl
Attributes: Required, Default: CR
Default Value: CR
Represents the type of credit policy supported for this profile.

XML Sample:

<profile/>

"<profile/>"

JSON Sample:

{
 
}

XURL Sample:

?