type
Type: String(60)
XML Representation: attribute
References: Processing Profile.
Type
Attributes:
Constant, Required, Default: cards-realtime/firstdata-omnipay
Default Value: cards-realtime/firstdata-omnipay
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.
isCreditEnabled
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
Indicates whether the credit operation is allowed.
isDebitProcessingEnabled
Type: Boolean
XML Representation: attribute
Attributes:
Default: false
Default Value: false
Indicates whether debit cards processing is possible using this profile.
aggregationFrequency
XML Representation: element
Attributes:
Default: D
Default Value: D
applicationId
Group: Payment Facilitator
SubGroup:
Type: String(16)
XML Representation: attribute
Attributes:
Required, Default: 998745546
Default Value: 998745546
Unique application identification number.
serviceId
Group: Payment Facilitator
SubGroup:
Type: String(3)
XML Representation: attribute
Attributes:
Required, Default: 139
Default Value: 139
Digital number that represents the specific code of the product/service.
mcAssignedId
Group: Payment Facilitator
SubGroup:
Type: String(6)
XML Representation: attribute
An identifier assigned by MasterCard to identify a specific merchant who is registered with MasterCard for specific fees, special interchange treatment, or participation in select acceptance programs.
countryCode
Group: Payment Facilitator
SubGroup:
Type: String(2)
XML Representation: attribute
Country code of the merchant.
Needs to state 3 digit alpha-numeric country code.
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.
merchantName
Group: Merchant
SubGroup: General
Type: String(19)
XML Representation: attribute
The DBA name of the merchant.
acquirerInstitutionId
Group: Merchant
SubGroup: General
Type: String(11)
XML Representation: attribute
A code that identifies the institution receiving the request. This ID is used when it is not possible to route a message using the Account Number field. When this field is included, it takes precedence over all account number fields for routing.
authorizationCurrencyCode
Group: Merchant
SubGroup: General
Type: String(3)
XML Representation: attribute
Represents the type of currency used for authorization.
captureCurrencyCode
Group: Merchant
SubGroup: General
Type: String(3)
XML Representation: attribute
Represents the type of currency used for capture.
merchantStreet
Group: Merchant
SubGroup: Address
Type: String(20)
XML Representation: attribute
Street address associated with this merchant account.
merchantCity
Group: Merchant
SubGroup: Address
Type: String(13)
XML Representation: attribute
City associated with this merchant account.
merchantCountryCode
Group: Merchant
SubGroup: Address
Type: String(2)
XML Representation: attribute
Code of the country associated with this merchant account.
merchantState
Group: Merchant
SubGroup: Address
Type: String(3)
XML Representation: attribute
State code associated with this merchant account.
merchantZipCode
Group: Merchant
SubGroup: Address
Type: String(9)
XML Representation: attribute
ZIP/Postal code associated with this merchant account.
chargeDescription
Group: Merchant
SubGroup: Descriptor
Type: String(23)
XML Representation: attribute
The Charge Descriptions are agreed upon by the client and American Express, at the time the Electronic Submission Addendum is completed.
merchantCategoryCodeRetail
Group: Settings
SubGroup: Retail
Type: String(4)
XML Representation: attribute
A code that identifies the type of business or services conducted by the service establishment.
On a 0400 (Debit/EBT) reversal message, this field must match the original 0200 (Debit/EBT) request.
merchantIdRetail
Group: Settings
SubGroup: Retail
Type: String(22)
XML Representation: attribute
Contains a code assigned to a merchant location. Merchants must use the First Data-assigned Merchant ID. The Merchant ID does not
conform to the standard definition of alphanumeric fields: it is right-justified and zero-filled on the left.
On a 0100 VRU Authorization only, the Merchant ID can be the First Data internal number or a merchant external number.
On a 0400 reversal message, this field must match the original 0100/0200 request.
merchantNumberRetail
Group: Settings
SubGroup: Retail
Type: String(20)
XML Representation: attribute
Settlement 80 byte Merchant number. (Used in FirstData OmniPay)
terminalIdRetail
Group: Settings
SubGroup: Retail
Type: String(12)
XML Representation: attribute
Contains a code that identifies a merchant terminal. A unique code must be assigned to each terminal/POS device (e.g., a register) in a merchant location.
This code will be returned on the host response. In certain instances, the Terminal ID may be assigned by the merchant; in other instances, First Data assigns it.
The Terminal ID does not conform to the standard definition of alphanumeric fields: it is right justified and zero-filled on the left.
On a 0400 reversal message, this field must match the original 0100/0200 request
datawireIdRetail
Group: Settings
SubGroup: Retail
Type: String(20)
XML Representation: attribute
Datawire ID of the retail industry.
merchantCategoryCodeMoto
Group: Settings
SubGroup: MOTO
Type: String(4)
XML Representation: attribute
A code that identifies the type of business or services conducted by the service establishment.
On a 0400 (Debit/EBT) reversal message, this field must match the original 0200 (Debit/EBT) request.
merchantIdMoto
Group: Settings
SubGroup: MOTO
Type: String(22)
XML Representation: attribute
Contains a code assigned to a merchant location. Merchants must use the First Data-assigned Merchant ID. The Merchant ID does not
conform to the standard definition of alphanumeric fields: it is right-justified and zero-filled on the left.
On a 0100 VRU Authorization only, the Merchant ID can be the First Data internal number or a merchant external number.
On a 0400 reversal message, this field must match the original 0100/0200 request.
merchantNumberMoto
Group: Settings
SubGroup: MOTO
Type: String(20)
XML Representation: attribute
Settlement 80 byte Merchant number. (Used in FirstData OmniPay)
terminalIdMoto
Group: Settings
SubGroup: MOTO
Type: String(12)
XML Representation: attribute
Contains a code that identifies a merchant terminal. A unique code must be assigned to each terminal/POS device (e.g., a register) in a merchant location.
This code will be returned on the host response. In certain instances, the Terminal ID may be assigned by the merchant; in other instances, First Data assigns it.
The Terminal ID does not conform to the standard definition of alphanumeric fields: it is right justified and zero-filled on the left.
On a 0400 reversal message, this field must match the original 0100/0200 request
datawireIdMoto
Group: Settings
SubGroup: MOTO
Type: String(20)
XML Representation: attribute
merchantCategoryCodeEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(4)
XML Representation: attribute
A code that identifies the type of business or services conducted by the service establishment.
On a 0400 (Debit/EBT) reversal message, this field must match the original 0200 (Debit/EBT) request.
merchantIdEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(22)
XML Representation: attribute
Contains a code assigned to a merchant location. Merchants must use the First Data-assigned Merchant ID. The Merchant ID does not
conform to the standard definition of alphanumeric fields: it is right-justified and zero-filled on the left.
On a 0100 VRU Authorization only, the Merchant ID can be the First Data internal number or a merchant external number.
On a 0400 reversal message, this field must match the original 0100/0200 request.
merchantNumberEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(20)
XML Representation: attribute
Settlement 80 byte Merchant number. (Used in FirstData OmniPay)
terminalIdEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(12)
XML Representation: attribute
Contains a code that identifies a merchant terminal. A unique code must be assigned to each terminal/POS device (e.g., a register) in a merchant location.
This code will be returned on the host response. In certain instances, the Terminal ID may be assigned by the merchant; in other instances, First Data assigns it.
The Terminal ID does not conform to the standard definition of alphanumeric fields: it is right justified and zero-filled on the left.
On a 0400 reversal message, this field must match the original 0100/0200 request
datawireIdEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(20)
XML Representation: attribute
Datawire ID of the e-commerce.
hostAuthorization
Group: Authorization
SubGroup:
Type: String(160)
XML Representation: attribute
Attributes:
Required, Default: https://staging1.datawire.net/sd
Default Value: https://staging1.datawire.net/sd
Host to be used for HTTPs based connectivity.
portAuthorization
Group: Authorization
SubGroup:
Type: Integer
XML Representation: attribute
Attributes:
Default: 443
Default Value: 443
Port to be used for HTTPs based connectivity.
useLegacyFileHeader
Group: Settlement
SubGroup: Merchant
Type: Boolean
XML Representation: attribute
Attributes:
Default: false
Default Value: false
File header that contains Transaction Code, PSP Name, File Creation Date, File Reference, File Identification and Test/Prod Identifier.
fileName
Group: Settlement
SubGroup: Merchant
Type: String(50)
XML Representation: attribute
References: Retail ISO8583 Profile.
Filename
secureCode
Group: Settlement
SubGroup: Merchant
Type: String(4)
XML Representation: attribute
Attributes:
Required, Default: 6584
Default Value: 6584
visaBinOverride
Group: Settlement
SubGroup: Merchant
Type: String(6)
XML Representation: attribute
References: Retail ISO8583 Profile.
Visa BIN
BIN accosiated with Visa cards.
mcBinOverride
Group: Settlement
SubGroup: Merchant
Type: String(6)
XML Representation: attribute
References: Retail ISO8583 Profile.
MC BIN
BIN accosiated with MasterCard cards.
hostSettlement
Group: Settlement
SubGroup: Connectivity
Type: String(100)
XML Representation: attribute
Attributes:
Required, Default: my.ftp-host.com
Default Value: my.ftp-host.com
Host used for FTP/sFTP based connectivity.
portSettlement
Group: Settlement
SubGroup: Connectivity
Type: Integer
XML Representation: attribute
Attributes:
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: sampleUser
Default Value: sampleUser
Username used for HTTPs based connectivity.
passwordSettlement
Group: Settlement
SubGroup: Connectivity
Type: String(100)
XML Representation: attribute
Attributes:
Encrypted, Default: password
Default Value: password
Password used for HTTPs based connectivity.
requestPathSettlement
Group: Settlement
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.
Outbox
Attributes:
Default: outbox
Default Value: outbox
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: inbox
Default Value: inbox
Location where files are uploaded for processing.
keyNameSSH
Group: Settlement
SubGroup: SSH
Type: String(100)
XML Representation: attribute
Attributes:
Default: samplePrivateKey.ssh
Default Value: samplePrivateKey.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: samplePhrase
Default Value: samplePhrase
Passphrase of the private SSH key used for FTP/sFTP based connectivity.
