type
Type: String
XML Representation: attribute
Attributes:
Constant, Required, Default: amex-realtime/direct
Default Value: amex-realtime/direct
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.
aggregationFrequency
XML Representation: element
Attributes:
Default: D
Default Value: D
filename
Group: Payment Facilitator
SubGroup:
Type: String
XML Representation: attribute
References: Retail ISO8583 Profile.
Filename
Attributes:
Required, Default: filename.ext
Default Value: filename.ext
Name of the file.
File name
headerMerchantId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: 4569
Default Value: 4569
acquirerInstitutionId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Default: 123456789
Default Value: 123456789
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.
Acquirer Institution Id
submitterId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
References: Retail ISO8583 Profile.
TPP ID
Attributes:
Required, Default: tpp123
Default Value: tpp123
Third Party Processor ID - The TPP ID is mandatory on all Authorization requests submitted by Third Parties who have been issued one by First Data. If you were assigned a Third Party Processor ID, you are required to send this additional format record.
If you were not assigned a Third Party Processor ID, this record should not be sent.
authorizationCurrencyCode
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: USD
Default Value: USD
Represents the type of currency used for authorization.
captureCurrencyCode
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: USD
Default Value: USD
Represents the type of currency used for capture.
merchantCity
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Required, Default: New York
Default Value: New York
City associated with this merchant account.
merchantCountryCode
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Code of the country associated with this merchant account.
merchantState
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Required, Default: NY
Default Value: NY
State code associated with this merchant account.
merchantStreet
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Required, Default: 5th Ave.
Default Value: 5th Ave.
Street address associated with this merchant account.
merchantZip
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Required, Default: 586549513
Default Value: 586549513
ZIP/Postal code associated with this merchant account.
merchantEmail
Group: Merchant
SubGroup: Address
Type: String
XML Representation: attribute
Attributes:
Default: sample@ut.com
Default Value: sample@ut.com
Merchant Email
Merchant Email
merchantName
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Required, Default: Sample Merchant Name
Default Value: Sample Merchant Name
The DBA name of the merchant.
Merchant Name
aggregatorName
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Required, Default: Any Name
Default Value: Any Name
Aggregator Name
Aggregator Name
customerServicePhone
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Required, Default: 5002214498
Default Value: 5002214498
Service phone of the customer used for discussing any processing issues.
merchantCategoryCodeRetail
Group: Settings
SubGroup: Retail
Type: String
XML Representation: attribute
Attributes:
Default: 4569
Default Value: 4569
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
XML Representation: attribute
Attributes:
Default: 654888
Default Value: 654888
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.
merchantCategoryCodeMoto
Group: Settings
SubGroup: MOTO
Type: String
XML Representation: attribute
Attributes:
Default: 1111
Default Value: 1111
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.
Moto Merchant Category Code
merchantIdMoto
Group: Settings
SubGroup: MOTO
Type: String
XML Representation: attribute
Attributes:
Default: motoId123
Default Value: motoId123
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.
merchantCategoryCodeEcommerce
Group: Settings
SubGroup: eCommerce
Type: String
XML Representation: attribute
Attributes:
Default: 2222
Default Value: 2222
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
XML Representation: attribute
Attributes:
Default: ecommerceId123
Default Value: ecommerceId123
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.
merchantCategoryCodeRestaurant
Group: Settings
SubGroup: Restaurant
Type: String
XML Representation: attribute
Attributes:
Default: 3333
Default Value: 3333
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.
merchantIdRestaurant
Group: Settings
SubGroup: Restaurant
Type: String
XML Representation: attribute
Attributes:
Default: restaurantId123
Default Value: restaurantId123
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.
networkRouting
Group: Authorization
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Required, Default: 123
Default Value: 123
Zeros filled in the request message, debit Network ID will be included as response values.
connectionTypeAuthorization
Group: Authorization
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Constant, Required, Default: AX
Default Value: AX
Type of connectivity to use to exchange messages/files with a processor.
hostAuthorization
Group: Authorization
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Required, Default: https://9mklnru3.amextestsystem.com/IPPayments/inter/CardAuthorization.do
Default Value: https://9mklnru3.amextestsystem.com/IPPayments/inter/CardAuthorization.do
Host to be used for HTTPs based connectivity.
connectionTypeSettlement
Group: Settlement
SubGroup: Connectivity
Type: String
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
XML Representation: attribute
Attributes:
Required, Default: fsgateway.aexp.com
Default Value: fsgateway.aexp.com
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
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:
Required, Encrypted, Default: samplePassword
Default Value: samplePassword
Password used for HTTPs based connectivity.
requestPathSettlement
Group: Settlement
SubGroup: Path
Type: String
XML Representation: attribute
References: Provider Account.
Outbox
Attributes:
Default: inbound
Default Value: inbound
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
XML Representation: attribute
References: Provider Account.
Inbox
Attributes:
Default: outbound
Default Value: outbound
Location where files are uploaded for processing.
keyNameSSH
Group: Settlement
SubGroup: SSH
Type: String
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: samplePhrase
Default Value: samplePhrase
Passphrase of the private SSH key used for FTP/sFTP based connectivity.