KeyBankACHProviderProfile

Type:  Struct
Abstract:  no
Status:  Active
Configuration settings for ACH processing through KeyBank.
Avalible Field Groups:
type
Group: System
SubGroup:
Type: String(60)
XML Representation: attribute
References: Processing Profile.Type
Attributes: Constant, Required, Default: ach/keybank
Default Value: ach/keybank
Type of the Provider Profile.
isActive
Group: System
SubGroup:
Type: Boolean
XML Representation: attribute
References: Processing Profile.Is Active
Attributes: Default: true
Default Value: true
Indicates whether the record is active in the system.
isCreditEnabled
Group: System
SubGroup:
Type: Boolean
XML Representation: attribute
References: Processing Profile.Is Credit Enabled
Attributes: Default: true
Default Value: true
Indicates whether the credit operation is allowed.
aggregationFrequency
Group: System
SubGroup:
Type: String
XML Representation: attribute
Attributes:
Pattern: AGGREGATION_FREQUENCY
Indicates files aggregation frequency to be used for this Merchant/Merchant Account. See the File Management Guide for more information.
companyId
Group: Merchant
SubGroup: General
Type: String(10)
XML Representation: attribute
References: EFT NACHA Profile.Sale Company ID
Attributes: Required
Pattern: NUMERIC
ID of the company (originator of the transaction) assigned by the bank to process sales.
companyName
Group: Merchant
SubGroup: General
Type: String(16)
XML Representation: attribute
References: EFT NACHA Profile.Company Name
Attributes: Required
Pattern: DOCUMENT_NUMBER
Name of the company that originates transactions.
immediateOrigin
Group: Merchant
SubGroup: General
Type: String(10)
XML Representation: attribute
References: EFT NACHA Profile.Immediate Origin
Attributes: Required
Pattern: NUMERIC
Assigned by provider (it seems this field is linked to routing number)
immediateOriginName
Group: Merchant
SubGroup: General
Type: String(23)
XML Representation: attribute
References: EFT NACHA Profile.Immediate Origin Name
Attributes: Required
Pattern: DOCUMENT_NUMBER
Name of the Originating Company
filename
Group: Merchant
SubGroup: General
Type: String(40)
XML Representation: attribute
References: EFT NACHA Profile.Filename
Attributes: Required
Pattern: FILENAME
Name of the file to use for EFT transfer.
descriptor
Group: Merchant
SubGroup: Descriptor
Type: String(10)
XML Representation: attribute
References: EFT NACHA Profile.Description
Attributes: Required
Pattern: DESCRIPTOR
Descriptor that will appear on the cardholder’s statement. If this field is blank the descriptor is reset to the default at the division level.
connectionType
Group: Submission
SubGroup: Connectivity
Type: String(30)
XML Representation: attribute
References: Provider Account.Primary Connection Type
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(100)
XML Representation: attribute
References: Provider Account.FTP Host
Attributes: Required, Default: ftp.mybank.com
Default Value: ftp.mybank.com
Pattern: URL
Host used for FTP/sFTP based connectivity.
port
Group: Submission
SubGroup: Connectivity
Type: Integer
XML Representation: attribute
References: Provider Account.FTP Port
Attributes: Required, Default: 22
Default Value: 22
Port used for FTP/sFTP based connectivity.
username
Group: Submission
SubGroup: Connectivity
Type: String(50)
XML Representation: attribute
References: Provider Account.Username
Attributes: Required, Default: user100
Default Value: user100
Pattern: USERNAME
Username used for HTTPs based connectivity.
password
Group: Submission
SubGroup: Connectivity
Type: String(100)
XML Representation: attribute
References: Provider Account.Password
Attributes: Encrypted, Default: password100
Default Value: password100
Pattern: PASSWORD
Password used for HTTPs based connectivity.
requestPath
Group: Submission
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.Outbox
Attributes: Default: outbox/
Default Value: outbox/
Pattern: PATH
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(100)
XML Representation: attribute
References: Provider Account.Inbox
Attributes: Default: inbox/
Default Value: inbox/
Pattern: PATH
Location where files are uploaded for processing.
keyNameSSH
Group: Submission
SubGroup: SSH
Type: String(100)
XML Representation: attribute
References: Provider Account.SSH Private Key File Name
Attributes: Default: Sample PrivateKey.ssh
Default Value: Sample PrivateKey.ssh
Pattern: FILENAME
Name of the private SSH key to be used for FTP/sFTP based connectivity (for sFTP communication)
passphraseSSH
Group: Submission
SubGroup: SSH
Type: String(100)
XML Representation: attribute
References: Provider Account.SSH Pass Phrase
Attributes: Encrypted, Default: Sample Phrase
Default Value: Sample Phrase
Pattern: PASSWORD
Passphrase of the private SSH key used for FTP/sFTP based connectivity.

XML Sample:

<profile/>

"<profile/>"

JSON Sample:

{
 
}

XURL Sample:

?