TsysCardsRealtimeProviderProfile

Type:  Struct
Abstract:  no
Status:  Active
Configuration settings for cards realtime processing through Tsys
type
Group: System
SubGroup:
Type: String(60)
XML Representation: attribute
References: Processing Profile.Type
Attributes: Constant, Required, Default: cards-realtime/tsys
Default Value: cards-realtime/tsys
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.
connectionMode
Group: Configuration
SubGroup:
Type: String(3)
XML Representation: attribute
References: Retail Profile.Connection Mode CL
Attributes: Required, Default: SSL
Default Value: SSL
Pattern: CONNECTION_MODE
Represents the type of connection mode for this profile.
authorizationExpirationPeriod
Group: System
SubGroup:
Type: Integer
XML Representation: attribute
References: Retail Profile.Authorization Expiration Period
Attributes: Default: 7
Default Value: 7
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.
isDebitCardProcessingEnabled
Group: System
SubGroup:
Type: Boolean
XML Representation: attribute
References: Retail Profile.Is Debit Card Processing Enabled
Attributes: Default: false
Default Value: false
Indicates whether debit cards processing is possible using this profile.
paymentFacilitatorIdVisa
Group: Payment Facilitator
SubGroup:
Type: String(11)
XML Representation: attribute
References: Retail TSYS Profile.Payment Facilitator Id Visa
Attributes:
Pattern: NUMERIC
paymentFacilitatorIdMasterCard
Group: Payment Facilitator
SubGroup:
Type: String(11)
XML Representation: attribute
References: Retail TSYS Profile.Payment Facilitator Id Master Card
Attributes:
Pattern: NUMERIC
Identifier of the payment facilitator assigned by the processor.
paymentFacilitatorIdAmex
Group: Payment Facilitator
SubGroup:
Type: String(20)
XML Representation: attribute
References: Retail TSYS Profile.Seller Id
Attributes:
Pattern: NUMERIC
paymentFacilitatorName
Group: Payment Facilitator
SubGroup:
Type: String(20)
XML Representation: attribute
References: Retail TSYS Profile.Payment Service Provider Name
Attributes:
Pattern: ALPHANUMERIC
developerId
Group: Payment Facilitator
SubGroup:
Type: String(6)
XML Representation: attribute
References: Retail TSYS Profile.Developer ID
Attributes: Required
Pattern: ALPHANUMERIC
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
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.
subMerchantId
Group: Payment Facilitator
SubGroup: Sub-Merchant
Type: String(15)
XML Representation: attribute
References: Retail TSYS Profile.Sub Merchant ID
Attributes: Default: 12345
Default Value: 12345
Pattern: NUMERIC
Identifier of the sub-merchant account assigned by a processor.
subMerchantCity
Group: Payment Facilitator
SubGroup: Sub-Merchant
Type: String(13)
XML Representation: attribute
References: Retail TSYS Profile.Sub Merchant City
Attributes:
Pattern: ALPHANUMERIC_EXTENDED
City of the address associated with the sub-merchant account.
subMerchantCountryCode
Group: Payment Facilitator
SubGroup: Sub-Merchant
Type: String(3)
XML Representation: attribute
References: Retail TSYS Profile.Sub Merchant Country Code
Attributes: Default: US, CA
Default Value: US, CA
Pattern: USA_CANADA
subMerchantState
Group: Payment Facilitator
SubGroup: Sub-Merchant
Type: String(2)
XML Representation: attribute
References: Retail TSYS Profile.Sub Merchant State Province Code
Attributes:
State/Province code of the address associated with the sub-merchant account.
subMerchantZipCode
Group: Payment Facilitator
SubGroup: Sub-Merchant
Type: String(9)
XML Representation: attribute
References: Retail TSYS Profile.Sub Merchant Zip Code
Attributes:
merchantName
Group: Merchant
SubGroup: General
Type: String(25)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Name
Attributes: Required
Pattern: NAME_BUSINESS
Contains the merchant name provided by the signing member or processor. Must contain the same data used in the data capture batch.
merchantNumber
Group: Merchant
SubGroup: General
Type: String(12)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Number
Attributes: Required
Pattern: NUMERIC
Assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system.
merchantNumberBackend
Group: Merchant
SubGroup: General
Type: String(15)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Number Backend
Attributes:
acquirerBin
Group: Merchant
SubGroup: General
Type: String(6)
XML Representation: attribute
References: Retail TSYS Profile.Acquirer BIN
Attributes: Required, Default: 008523
Default Value: 008523
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: 001233
Default Value: 001233
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: 003369
Default Value: 003369
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
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.
terminalNumber    
Group: Merchant
SubGroup: General
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Terminal Number
Attributes: Required
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.
terminalId
Group: Merchant
SubGroup: General
Type: String(8)
XML Representation: attribute
References: Retail TSYS Profile.Terminal ID Number
Attributes: Required
Pattern: NUMERIC
Assigned by the processor.
4.299 Terminal identification number
This eight-character numeric field contains the number to accommodate a POS device
tracking number (see Table 3.20for record format). This field is also known as the “V”
number.
NOTE: The “V” alpha character must be changed to numeric seven when sending
this field.
merchantLocationNumber
Group: Merchant
SubGroup: General
Type: String(5)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Location Number
Attributes: Required
Pattern: NUMERIC
Provides additional information on the location of the merchant. Unless otherwise specified by the merchant’s bank or processor, it should be defaulted to 00001.
merchantCategoryCode
Group: Merchant
SubGroup: General
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Category
Attributes: Required
Pattern: NUMERIC
Merchant category code assigned by the signing member or processor to identify a merchant industry classification. This value is similar to the Standard Industry Code (SIC).
sharingGroups
Group: Merchant
SubGroup: General
Type: String(30)
XML Representation: attribute
References: Retail TSYS Profile.Sharing Groups
Attributes:
Pattern: ALPHANUMERIC
Contains a listing of direct debit and EBT networks that a POS device can access. Provided by the signing member or processor. The values must correspond to one of the Visa assigned direct debit network types. This data is part of the TSYS Acquiring Solutions direct debit data.
networkId
Group: Merchant
SubGroup: General
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Network ID
Attributes:
Pattern: NUMERIC
Contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.
merchantSettlementAgentNumber
Group: Merchant
SubGroup: General
Type: String(4)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Settlement Agent Number
Attributes:
Pattern: ALPHANUMERIC
Identifies the merchant settling agent. This number is provided by the signing member or processor.
merchantAbaNumber
Group: Merchant
SubGroup: General
Type: String(255)
XML Representation: attribute
References: Retail TSYS Profile.Merchant ABA Number
Attributes:
Pattern: NUMERIC
Identifies the merchant to a direct debit switch. Must be supplied for all direct debit request transactions except for the Interlink Debit Cancel (Transaction Code 95). This number is provided by the signing member or processor.
vatRegistrationNumber
Group: Merchant
SubGroup: General
Type: String(20)
XML Representation: attribute
References: Retail TSYS Profile.VAT Registration Number
Attributes:
Pattern: ALPHANUMERIC
Government assigned tax identification number of the merchant from whom the goods or services were purchased from.
fcsId
Group: Merchant
SubGroup: General
Type: String(7)
XML Representation: attribute
References: Retail TSYS Profile.FCS ID
Attributes:
Pattern: ALPHANUMERIC
Contains the Food and Consumer Identifier. The FCS ID identifies the Merchant as being certified and approved to accept Food Stamps.
Note: Cash benefits transactions do not use the Electronic Voucher Serial Number, FCS ID, and Voucher Approval Code fields; food stamp transactions must use the FCS ID. Electronic voucher transactions require Electronic Voucher Serial Number, FCS ID, and Voucher Approval Code fields.
authorizationCurrencyCode
Group: Merchant
SubGroup: General
Type: String(3)
XML Representation: attribute
References: Processing Profile.Authorization Currency Code CL
Attributes: Default: USD
Default Value: USD
Represents the type of currency used for authorization.
captureCurrencyCode
Group: Merchant
SubGroup: General
Type: String(3)
XML Representation: attribute
References: Processing Profile.Capture Currency Code CL
Attributes: Default: USD
Default Value: USD
Represents the type of currency used for capture.
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
street
Group: Merchant
SubGroup: Address
Type: String(38)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Street
Attributes:
Pattern: STREET
city
Group: Merchant
SubGroup: Address
Type: String(13)
XML Representation: attribute
References: Retail TSYS Profile.Merchant City
Attributes: Required
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.
countryCode
Group: Merchant
SubGroup: Address
Type: String(3)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Country Code
Attributes: Required, Default: US, CA
Default Value: US, CA
Pattern: USA_CANADA
Country code of the address associated with the sub-merchant account.
state
Group: Merchant
SubGroup: Address
Type: String(2)
XML Representation: attribute
References: Retail TSYS Profile.Merchant State
Attributes: Required
Contains the merchant State/Province Code provided by the signing member or processor. Must contain the same data used in the data capture batch.
zipCode
Group: Merchant
SubGroup: Address
Type: String(9)
XML Representation: attribute
References: Retail TSYS Profile.City Code
Attributes: Required, Default: 00010
Default Value: 00010
Code used to further identify the merchant location.
emailSample
Group: Merchant
SubGroup: Address
Type: String(20)
XML Representation: attribute
References: Retail TSYS Profile.Merchant Email
Attributes:
Pattern: TEXT
descriptorPrefix
Group: Merchant
SubGroup: Descriptor
Type: String(3)
XML Representation: attribute
References: Retail TSYS Profile.Descriptor Prefix
Attributes: Default: AS3
Default Value: AS3
Pattern: ALPHANUMERIC
descriptor
Group: Merchant
SubGroup: Descriptor
Type: String(21)
XML Representation: attribute
References: Retail TSYS Profile.Descriptor
Attributes:
Pattern: DESCRIPTOR
contactPhone
Group: Merchant
SubGroup: Descriptor
Type: String(15)
XML Representation: attribute
References: Retail TSYS Profile.Contact Phone Number
Attributes: Required
Pattern: NUMERIC
Phone number of the contact person
connectionType
Group: Authorization
SubGroup:
Type: String(30)
XML Representation: attribute
References: Provider Account.Primary Connection Type
Attributes: Required, Default: TSYS
Default Value: TSYS
Type of connectivity to use to exchange messages/files with a processor.
host
Group: Authorization
SubGroup:
Type: String(160)
XML Representation: attribute
References: Provider Account.Http Host
Attributes: Required, Default: https://tsys.retail.net
Default Value: https://tsys.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: Default: 443
Default Value: 443
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:

?