type
Type: String(60)
XML Representation: attribute
References: Processing Profile.
Type
Attributes:
Constant, Required, Default: cards-realtime/elavon-viaconex4
Default Value: cards-realtime/elavon-viaconex4
isActive
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
Indicates whether the record is active in the system.
accountProcessingPolicy
Type: String(10)
XML Representation: attribute
Attributes:
Required, Default: VMXD——*U
Default Value: VMXD——*U
Type of processing policy for the account.
aggregationFrequency
XML Representation: element
Attributes:
Default: D
Default Value: D
isDebitProcessingEnabled
Type: Boolean
XML Representation: attribute
Attributes:
Default: false
Default Value: false
Indicates whether debit cards processing is possible using this profile.
authorizationExpirationPeriod
Type: Integer
XML Representation: attribute
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.
Number of days during which an authorization can remain unsettled. When the value is greater than 0, any un-captured (unconfirmed) transactions will not be reversed until the expiration period is reached.
Note: the value of the expiration period cannot exceed the lifetime of an authorization allowed by the processor that was used to get it.
paymentFacilitatorId
Group: Payment Facilitator
SubGroup:
Type: String(11)
XML Representation: attribute
vendorId
Group: Payment Facilitator
SubGroup:
Type: String(4)
XML Representation: attribute
Attributes:
Required, Default: 2323
Default Value: 2323
This value is assigned by the Vendor Certification Department of ELAVON.
This number is an alphanumeric value and should be capitalized. All Vendor Certification Device Types are value of "Z".
destinationNumber
Group: Payment Facilitator
SubGroup:
Type: String(4)
XML Representation: attribute
Attributes:
Required, Default: 0225
Default Value: 0225
The Country Code of the destination address.
isTestMode
Group: Merchant
SubGroup: General
Type: Boolean
XML Representation: attribute
Attributes:
Default: false
Default Value: false
Indicates that this transaction should be processed in test mode, when it is handled by the processor.
bankNumber
Group: Merchant
SubGroup: General
Type: String(6)
XML Representation: attribute
References: Retail Elavon Profile.
Bank Nbr
Attributes:
Required, Default: 123456
Default Value: 123456
This six digit fixed length value is assigned by Elavon.
merchantName
Group: Merchant
SubGroup: General
Type: String(25)
XML Representation: attribute
Merchant DBA override data.
This value contains the “Doing Business As” name override data from the merchant. If this value is not present, then Elavon will use the DBA name on file.
institutionName
Group: Merchant
SubGroup: General
Type: String(25)
XML Representation: attribute
authorizationCurrencyCode
Group: Merchant
SubGroup: General
Type: Enum
XML Representation: attribute
Represents the type of currency used for authorization.
captureCurrencyCode
Group: Merchant
SubGroup: General
Type: Enum
XML Representation: attribute
Represents the type of currency used for capture.
isFileRenamingRequired
Group: Merchant
SubGroup: General
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
merchantStreetAddress
Group: Merchant
SubGroup: Address
Type: String(30)
XML Representation: attribute
Street of the mailing address for the merchant.
merchantCity
Group: Merchant
SubGroup: Address
Type: String(13)
XML Representation: attribute
City of the mailing address for the merchant.
merchantCountry
Group: Merchant
SubGroup: Address
Type: String(2)
XML Representation: attribute
Country code of the mailing address for the merchant.
merchantState
Group: Merchant
SubGroup: Address
Type: String(2)
XML Representation: attribute
State of the mailing address for the merchant.
merchantZip
Group: Merchant
SubGroup: Address
Type: String(9)
XML Representation: attribute
Postal code (ZIP code) of the mailing address for the merchant.
descriptor
Group: Merchant
SubGroup: Descriptor
Type: String(21)
XML Representation: attribute
Catalogue name/product type/installment information.
descriptorPrefix
Group: Merchant
SubGroup: Descriptor
Type: String(3)
XML Representation: attribute
Attributes:
Default: DF3
Default Value: DF3
Abbreviated corporate name.
customerServicePhone
Group: Merchant
SubGroup: Descriptor
Type: String(10)
XML Representation: attribute
Attributes:
Required, Default: 5002214498
Default Value: 5002214498
Customer service telephone number.
merchantIdRetail
Group: Settings
SubGroup: Retail
Type: String(15)
XML Representation: attribute
Retail merchant identification number. Provided by the processor.
terminalNumberRetail
Group: Settings
SubGroup: Retail
Type: String(16)
XML Representation: attribute
This sixteen digit fixed length value is assigned by Elavon.
Identifies a processing device associated to a Point of Sale division. This is not a required Format Indicator for retail transactions, but should be provided if possible to meet association rules and qualify for the best interchange rates.
Terminal override field.
merchantIdMoto
Group: Settings
SubGroup: MOTO
Type: String(15)
XML Representation: attribute
MOTO merchant identification number. Provided by the processor.
terminalNumberMoto
Group: Settings
SubGroup: MOTO
Type: String(16)
XML Representation: attribute
This sixteen digit fixed length value is assigned by Elavon.
The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device.
Terminal override field.
merchantIdEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(15)
XML Representation: attribute
Ecommerce merchant identification number. Provided by the processor.
terminalNumberEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(16)
XML Representation: attribute
This sixteen digit fixed length value is assigned by Elavon.
The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device.
Terminal override field.
merchantIdRestaurant
Group: Settings
SubGroup: Restaurant
Type: String(15)
XML Representation: attribute
Restaurant merchant identification number. Provided by the processor.
terminalNumberRestaurant
Group: Settings
SubGroup: Restaurant
Type: String(16)
XML Representation: attribute
This variable length value is assigned by Elavon and has a minimum length of 1 and a maximum length of 16.
The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device.
Terminal override field.
keyPointerType
Group: Authorization
SubGroup:
Type: String(2)
XML Representation: attribute
Attributes:
Required, Default: TD
Default Value: TD
Enumeration of key pointer values for Elavon.
connectionTypeAuthorization
Group: Authorization
SubGroup:
Type: String(30)
XML Representation: attribute
Attributes:
Constant, Required, Default: HTTPS
Default Value: HTTPS
Type of connectivity to use to exchange messages/files with a processor.
hostAuthorization
Group: Authorization
SubGroup:
Type: String(160)
XML Representation: attribute
Attributes:
Required, Default: https://testgate.viaconex.com/cgi-bin/encompass4.cgi
Default Value: https://testgate.viaconex.com/cgi-bin/encompass4.cgi
Host to be used for HTTPs based connectivity.
registrationKey
Group: Authorization
SubGroup:
Type: String(20)
XML Representation: attribute
References: Retail Elavon Profile.
Reg Key
Attributes:
Required, Default: 8ABCD0004355
Default Value: 8ABCD0004355
Required in all Scripts sent to the Elavon Host for processing and will be sent as a HTTP Header Field in the Post request.
Notes: The Registration Key should be sent as an HTTP Header field.
The NOVA_PORTAL_FAKE_KEY is only used to send transactions to the Elavon development host and cannot be used to send traffic to production hosts. A production Registration Key will be assigned by the Certification Department after certification is complete and is 20 characters long.
connectionTypeSettlement
Group: Settlement
SubGroup: Connectivity
Type: String(30)
XML Representation: attribute
Attributes:
Constant, Required, Default: SFTP
Default Value: SFTP
Secondary/additional type of connectivity used to exchange messages/files with a provider. The value is used when more than one protocol is involved in communication process (for example, real time authorization and batch settlement).
hostSettlement
Group: Settlement
SubGroup: Connectivity
Type: String(100)
XML Representation: attribute
Attributes:
Required, Default: sftp.novainfo.net
Default Value: sftp.novainfo.net
Host used for FTP/sFTP based connectivity.
portSettlement
Group: Settlement
SubGroup: Connectivity
Type: Integer
XML Representation: attribute
Attributes:
Required, Default: 22
Default Value: 22
Port used for FTP/sFTP based connectivity.
usernameSettlement
Group: Settlement
SubGroup: Connectivity
Type: String(50)
XML Representation: attribute
Attributes:
Required, Default: Sample User
Default Value: Sample User
Username used for HTTPs based connectivity.
passwordSettlement
Group: Settlement
SubGroup: Connectivity
Type: String(100)
XML Representation: attribute
Attributes:
Encrypted, Default: Sample Password
Default Value: Sample Password
Password used for HTTPs based connectivity.
requestPathSettlement
Group: Settlement
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.
Outbox
Attributes:
Default: inbox
Default Value: inbox
Location from which response files are downloaded for processing. If value is not defined, the responses are downloaded from the upload location.
responsePathSettlement
Group: Settlement
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.
Inbox
Attributes:
Default: outbox
Default Value: outbox
Location where files are uploaded for processing.
keyNameSSH
Group: Settlement
SubGroup: SSH
Type: String(100)
XML Representation: attribute
Attributes:
Default: Sample PrivateKey.ssh
Default Value: Sample PrivateKey.ssh
Name of the private SSH key to be used for FTP/sFTP based connectivity (for sFTP communication)
passphraseSSH
Group: Settlement
SubGroup: SSH
Type: String(100)
XML Representation: attribute
Attributes:
Encrypted, Default: Sample Phrase
Default Value: Sample Phrase
Passphrase of the private SSH key used for FTP/sFTP based connectivity.
creditProcessingMode
Type: Enum
XML Representation: attribute
Attributes:
Required, Default: CR
Default Value: CR
Represents the type of credit policy supported for this profile.
