type
Type: String
XML Representation: attribute
Attributes:
Constant, Required, Default: amex-batch/direct
Default Value: amex-batch/direct
isActive
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
Indicates whether the record is active in the system.
retryAttemptsLimit
Type: Integer
XML Representation: attribute
Attributes:
Default: 2
Default Value: 2
Max quantity of attempts to rebill.
retryInterval
Type: Integer
XML Representation: attribute
Attributes:
Default: 1
Default Value: 1
Interval between the the date when unsuccessful transaction was returned (or the date of the last rebill) and the date of the next rebill.
aggregationFrequency
XML Representation: element
Attributes:
Default: D
Default Value: D
isCreditEnabled
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
Indicates whether the credit operation is allowed.
fileName
Group: Payment Facilitator
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Required, Default: SAMPLEPRD.ABPPI
Default Value: SAMPLEPRD.ABPPI
The name given to a file in order to distinguish it from other files in Amex system.
merchantId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: SAMPLE01088
Default Value: SAMPLE01088
Indicates which merchant sent the billing/enrollment file. This ID is assigned by the Automated Bill Payment Platform (ABPP) during merchant boarding.
An invalid entry in this field will result in file rejection.
serviceAccessId
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
References: CC Amex Profile.
Said
Attributes:
Required, Default: SML224
Default Value: SML224
This field contains the Service Access ID (SAID) assigned by American Express.
serviceEstablishmentNumber
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: 2194834437
Default Value: 2194834437
This field contains the American Express-assigned Service Establishment (SE) Number that is used to identify and pay merchants and authorized processors. It is also informally referred to as the “Partner ID” field, because it identifies an organizational “Partner” that has entered into an agreement with American Express to provide services to Cardholders. An invalid entry in this field will result in file rejection.
If you process transactions for multiple merchants, stores or locations, create a separate batch for each entity and enter the SE Number/Partner ID (that corresponds to the records that comprise this batch) in this field.
descriptor
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Required, Default: Sample Item
Default Value: Sample Item
The desired description for transactions when they appear on the banking statement of a customer.
customerServicePhone
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Required, Default: 2128852624
Default Value: 2128852624
This field must contain the merchant’s customer-service telephone number.
connectionType
Group: Submission
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Constant, Default: SFTP
Default Value: SFTP
Type of connectivity to use to exchange messages/files with a processor.
host
Group: Submission
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Required, Default: ftp.mybank.com
Default Value: ftp.mybank.com
Host used for FTP/sFTP based connectivity.
port
Group: Submission
SubGroup: Connectivity
Type: Integer
XML Representation: attribute
Attributes:
Required, Default: 22
Default Value: 22
Port used for FTP/sFTP based connectivity.
username
Group: Submission
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Required, Default: sampleUser
Default Value: sampleUser
Username used for HTTPs based connectivity.
password
Group: Submission
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Required, Encrypted, Default: samplePassword
Default Value: samplePassword
Password used for HTTPs based connectivity.
requestPath
Group: Submission
SubGroup: Path
Type: String
XML Representation: attribute
References: Provider Account.
Outbox
Attributes:
Required, 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.
responsePath
Group: Submission
SubGroup: Path
Type: String
XML Representation: attribute
References: Provider Account.
Inbox
Attributes:
Required, Default: outbox
Default Value: outbox
Location where files are uploaded for processing.
keyNameSSH
Group: Submission
SubGroup: SSH
Type: String
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: Submission
SubGroup: SSH
Type: String
XML Representation: attribute
Attributes:
Encrypted, Default: samplePhrase
Default Value: samplePhrase
Passphrase of the private SSH key used for FTP/sFTP based connectivity.
