type
Type: String
XML Representation: attribute
Attributes:
Constant, Required, Default: ach/westpac
Default Value: ach/westpac
isActive
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
Indicates whether the record is active in the system.
isCreditEnabled
Type: Boolean
XML Representation: attribute
Attributes:
Default: true
Default Value: true
Indicates whether the credit operation is allowed.
accountNumber
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: 123456789
Default Value: 123456789
When
Tokenization is not available and encryption is allowed on the server, the field contains encrypted credit card number or bank account number.
Note: if encryption is not allowed on the server and tokenization is not properly configured, transactions will fail and will not be either processed or persisted.
bsbNumber
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: 123456
Default Value: 123456
Bank State Branch (BSB) number used in Australia for a bank code, which is a branch identifier.
fileNumber
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: 123456
Default Value: 123456
Number of the file in the system.
remitterName
Group: Merchant
SubGroup: General
Type: String
XML Representation: attribute
Attributes:
Required, Default: ABC123456
Default Value: ABC123456
description
Group: Merchant
SubGroup: Descriptor
Type: String
XML Representation: attribute
Attributes:
Required, Default: ABC123456
Default Value: ABC123456
Short description of the file.
connectionType
Group: Submission
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Constant, Required, 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: www.host.com
Default Value: www.host.com
Host used for FTP/sFTP based connectivity.
port
Group: Submission
SubGroup: Connectivity
Type: Integer
XML Representation: attribute
Attributes:
Required, Default: 443
Default Value: 443
Port used for FTP/sFTP based connectivity.
username
Group: Submission
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Required, Default: username
Default Value: username
Username used for HTTPs based connectivity.
password
Group: Submission
SubGroup: Connectivity
Type: String
XML Representation: attribute
Attributes:
Required, Encrypted, Default: password
Default Value: password
Password used for HTTPs based connectivity.
requestPath
Group: Submission
SubGroup: Path
Type: String
XML Representation: attribute
References: Provider Account.
Outbox
Attributes:
Required, Default: samplePath.com/outbox
Default Value: samplePath.com/outbox
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: samplePath.com/inbox
Default Value: samplePath.com/inbox
Location where files are uploaded for processing.
keyNameSSH
Group: Submission
SubGroup: SSH
Type: String
XML Representation: attribute
Attributes:
Required, Default: merchant-private.asc
Default Value: merchant-private.asc
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:
Required, Encrypted, Default: samplePhrase
Default Value: samplePhrase
Passphrase of the private SSH key used for FTP/sFTP based connectivity.
keyNamePGP
Group: Submission
SubGroup: PGP
Type: String
XML Representation: attribute
Attributes:
Required, Default: merchant-private.asc
Default Value: merchant-private.asc
Name of the private PGP key to be used for FTP/sFTP based connectivity. The key is used to encrypt outgoing files.
passphrasePGP
Group: Submission
SubGroup: PGP
Type: String
XML Representation: attribute
Attributes:
Required, Encrypted, Default: samplePhrase
Default Value: samplePhrase
Passphrase of the private PGP key used for FTP/sFTP based connectivity. The key is used to encrypt outgoing files.
keyNameProviderPGP
Group: Submission
SubGroup: PGP
Type: String
XML Representation: attribute
Attributes:
Required, Default: smerchant-public.asc
Default Value: smerchant-public.asc
Name of the public PGP key of a processor that should be used for FTP/sFTP based connectivity. The key is used to decrypt processor's response files.
