type
Type: String(60)
XML Representation: attribute
References: Processing Profile.
Type
Attributes:
Constant, Required, Default: cards-realtime/firstdata-rapidconnect
Default Value: cards-realtime/firstdata-rapidconnect
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.
connectionMode
Group: Configuration
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Required, Default: SSL
Default Value: SSL
Represents the type of connection mode for this profile.
settlementMode
Group: Configuration
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Required, Default: TR
Default Value: TR
Represents the type of settlement mode for this profile.
isCreditEnabled
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
Indicates whether the credit operation is allowed.
isDebitCardProcessingEnabled
Type: Boolean
XML Representation: attribute
Attributes:
Default: false
Default Value: false
Indicates whether debit cards processing is possible using this profile.
tppId
Group: Payment Facilitator
SubGroup:
Type: String
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
TPP ID
Attributes:
Required, Default: ABC1234
Default Value: ABC1234
Rapid Connect ID assigned by FirstData for a specific version of vendor/merchant software.
isTestMode
Group: Merchant
SubGroup: General
Type: Boolean
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
Is Test Mode
Attributes:
Default: false
Default Value: false
Indicates whether the test mode is active for the customer.
groupId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
Group ID
Attributes:
Required, Default: ABC1234
Default Value: ABC1234
Unique ID assigned by FirstData to identify the group of merchants.
applicationId
Group: Payment Facilitator
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the application used for the transaction processing.
fnsNumber
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Default: 1234567
Default Value: 1234567
Code received by a merchant from government that allows to accept EBT cards.
dynamicMerchantName
Group: Soft Merchant Descriptor
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Default: 1234567
Default Value: 1234567
Dynamic field that contains name of the merchant.
dynamicMerchantAddress
Group: Soft Merchant Descriptor
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Default: 1234567
Default Value: 1234567
Dynamic field that contains address of the merchant.
dynamicMerchantCity
Group: Soft Merchant Descriptor
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Default: Denver
Default Value: Denver
Dynamic field that contains address city of the merchant.
dynamicMerchantCountry
Group: Soft Merchant Descriptor
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Constant, Default: US
Default Value: US
Dynamic field that contains address country code of the merchant.
dynamicMerchantState
Group: Soft Merchant Descriptor
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Default: AU
Default Value: AU
Dynamic field that contains address state code of the merchant.
dynamicMerchantCounty
Group: Soft Merchant Descriptor
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Dynamic field that contains address county code of the merchant.
dynamicMerchantZip
Group: Soft Merchant Descriptor
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Default: 586549513
Default Value: 586549513
Dynamic field that contains address ZIP/postal code of the merchant.
merchantName
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
Merchant Name
Attributes:
Required, Default: merchant-name999
Default Value: merchant-name999
Merchant name used as a DBA (Doing Business As) name on the FirstData merchant file.
merchantTaxId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Tax ID collected by a merchant for the transaction processing.
alternateMerchantId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Alternate ID assigned by FirstData Prepaid Closed Loop.
For additional information, please contact account representative.
merchantStreet
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Street of the merchant mailing address applied on the FirstData merchant file.
merchantCity
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
Merchant City
Attributes:
Default: ABC1234
Default Value: ABC1234
City of the merchant mailing address applied on the FirstData merchant profile.
countryCode
Group: Merchant
SubGroup: Address
Type: String(2)
XML Representation: attribute
Attributes:
Constant, Default: US
Default Value: US
Country code of the merchant mailing address.
merchantState
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Default: CA
Default Value: CA
State code of the merchant mailing address used on the FirstData merchant file.
merchantZip
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Default: 12345
Default Value: 12345
ZIP or postal code of the merchant mailing address used on the FirstData merchant file.
customerServicePhoneNumber
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Default: 1234567890
Default Value: 1234567890
Phone number used for resolving any processing issues.
chargeDescription
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Default: description
Default Value: description
Description of the file agreed upon by the client and American Express, at the time the Electronic Submission Addendum is completed.
retailMerchantCategoryCode
Group: Settings
SubGroup: Retail
Type: String
XML Representation: attribute
Attributes:
Default: 1234
Default Value: 1234
Code used to classify a retail industry of the merchant.
merchantIdRetail
Group: Settings
SubGroup: Retail
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Unique ID of the merchant associated with retail industry.
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.
merchantIdRetailSettlement
Group: Settings
SubGroup: Retail
Type: String
XML Representation: attribute
Attributes:
Default: 123456789012
Default Value: 123456789012
terminalIdRetail
Group: Settings
SubGroup: Retail
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the terminal associated with retail industry of the merchant.
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
Terminal override field.
datawireIdRetail
Group: Settings
SubGroup: Retail
Type: String(32)
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Identifier that represents the original source document reference number associated with retail industry of the merchant.
motoMerchantCategoryCode
Group: Settings
SubGroup: MOTO
Type: String
XML Representation: attribute
Attributes:
Default: 1234
Default Value: 1234
Code used to classify a MOTO industry of the merchant.
merchantIdMoto
Group: Settings
SubGroup: MOTO
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Unique ID of the merchant associated with MOTO industry.
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.
merchantIdMotoSettlement
Group: Settings
SubGroup: MOTO
Type: String
XML Representation: attribute
Attributes:
Default: 123456789012
Default Value: 123456789012
terminalIdMoto
Group: Settings
SubGroup: MOTO
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the terminal associated with MOTO industry of the merchant.
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
Terminal override field.
datawireIdMoto
Group: Settings
SubGroup: MOTO
Type: String(32)
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Identifier that represents the original source document reference number associated with MOTO industry of the merchant.
ecommerceMerchantCategoryCode
Group: Settings
SubGroup: eCommerce
Type: String
XML Representation: attribute
Attributes:
Default: 1234
Default Value: 1234
Code used to classify an eCommerce business of the merchant.
merchantIdEcommerce
Group: Settings
SubGroup: eCommerce
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Unique ID of the merchant associated with eCommerce industry.
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.
merchantIdEcommerceSettlement
Group: Settings
SubGroup: eCommerce
Type: String
XML Representation: attribute
Attributes:
Default: 123456789012
Default Value: 123456789012
terminalIdEcommerce
Group: Settings
SubGroup: eCommerce
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the terminal associated with eCommerce industry of the merchant.
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
Terminal override field.
datawireIdEcommerce
Group: Settings
SubGroup: eCommerce
Type: String(32)
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Identifier that represents the original source document reference number associated with eCommerce industry of the merchant.
ecommUrl
Group: Settings
SubGroup: eCommerce
Type: String
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
Ecomm URL
Attributes:
Default: ABC1234
Default Value: ABC1234
URL of the eCommerce site.
restaurantMerchantCategoryCode
Group: Settings
SubGroup: Restaurant
Type: String
XML Representation: attribute
Attributes:
Default: 1234
Default Value: 1234
Code used to classify a restaurant industry of the merchant.
merchantIdRestaurant
Group: Settings
SubGroup: Restaurant
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Unique ID of the merchant associated with restaurant industry.
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.
merchantIdRestaurantSettlement
Group: Settings
SubGroup: Restaurant
Type: String
XML Representation: attribute
Attributes:
Default: 123456789012
Default Value: 123456789012
terminalIdRestaurant
Group: Settings
SubGroup: Restaurant
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the terminal associated with restaurant industry of the merchant.
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
Terminal override field.
datawireIdRestaurant
Group: Settings
SubGroup: Restaurant
Type: String(32)
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Identifier that represents the original source document reference number associated with restaurant industry of the merchant.
lodgingMerchantCategoryCode
Group: Settings
SubGroup: Lodging
Type: String
XML Representation: attribute
Attributes:
Default: 1234
Default Value: 1234
Code used to classify a lodging industry of the merchant.
merchantIdLodging
Group: Settings
SubGroup: Lodging
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Unique ID of the merchant associated with lodging industry.
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.
merchantIdLodgingSettlement
Group: Settings
SubGroup: Lodging
Type: String
XML Representation: attribute
Attributes:
Default: 123456789012
Default Value: 123456789012
terminalIdLodging
Group: Settings
SubGroup: Lodging
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the terminal associated with lodging industry of the merchant.
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.
Terminal override field.
datawireIdLodging
Group: Settings
SubGroup: Lodging
Type: String(32)
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Identifier that represents the original source document reference number associated with lodging industry of the merchant.
petroleumMerchantCategoryCode
Group: Settings
SubGroup: Petroleum
Type: String
XML Representation: attribute
Attributes:
Default: 1234
Default Value: 1234
Code used to classify a petroleum industry of the merchant.
merchantIdPetroleum
Group: Settings
SubGroup: Petroleum
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Unique ID of the merchant associated with petroleum industry. 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.
terminalIdPetroleum
Group: Settings
SubGroup: Petroleum
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the terminal associated with petroleum industry of the merchant.
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.
Terminal override field.
datawireIdPetroleum
Group: Settings
SubGroup: Petroleum
Type: String(32)
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Identifier that represents the original source document reference number associated with petroleum industry of the merchant.
carRentalMerchantCategoryCode
Group: Settings
SubGroup: Car Rental
Type: String
XML Representation: attribute
Attributes:
Default: 1234
Default Value: 1234
Code used to classify a car rental industry of the merchant.
merchantIdCarRental
Group: Settings
SubGroup: Car Rental
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Unique ID of the merchant associated with eCommerce industry assigned by FirstData.
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.
merchantIdCarRentalSettlement
Group: Settings
SubGroup: Car Rental
Type: String
XML Representation: attribute
Attributes:
Default: 123456789012
Default Value: 123456789012
terminalIdCarRental
Group: Settings
SubGroup: Car Rental
Type: String
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
ID of the terminal associated with lodging industry of the merchant.
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
Terminal override field.
datawireIdCarRental
Group: Settings
SubGroup: Car Rental
Type: String(32)
XML Representation: attribute
Attributes:
Default: ABC1234
Default Value: ABC1234
Identifier that represents the original source document reference number associated with car rental industry of the merchant.
connectionType
Group: Authorization
SubGroup:
Type: String
XML Representation: attribute
Attributes:
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:
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
Port to be used for HTTPs based connectivity.
connectionTypeSettlement
Group: Settlement
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Constant, 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:
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
Username used for HTTPs based connectivity.
passwordSettlement
Group: Settlement
SubGroup: Connectivity
Type: String(100)
XML Representation: attribute
Password used for HTTPs based connectivity.
filename
Group: Settlement
SubGroup: Connectivity
Type: String
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
File Name
Attributes:
Default: filename
Default Value: filename
Name of the file that is downloaded.
secureCode
Group: Settlement
SubGroup: Connectivity
Type: String
XML Representation: attribute
References: Retail First Data Rapid Connect Profile.
Secure Code
Attributes:
Default: 6584
Default Value: 6584
Additional security layer for online credit and debit card transactions.
requestPathSettlement
Group: Settlement
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.
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
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.
