type
Type: String(60)
XML Representation: attribute
References: Processing Profile.
Type
Attributes:
Constant, Required, Default: ach-realtime/propay
Default Value: ach-realtime/propay
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.
accountNum
Group: Merchant
SubGroup:
Type: Integer
XML Representation: attribute
Attributes:
Required, Default: 12345
Default Value: 12345
Account number of the client in the system.
certStr
Group: Merchant
SubGroup:
Type: String(30)
XML Representation: attribute
Attributes:
Required, Encrypted, Default: 12345678901PASS
Default Value: 12345678901PASS
authorizationCurrencyCode
Group: Merchant
SubGroup:
Type: String(3)
XML Representation: attribute
Attributes:
Required, Default: USD
Default Value: USD
Represents the type of currency used for authorization.
captureCurrencyCode
Group: Merchant
SubGroup:
Type: String(3)
XML Representation: attribute
Attributes:
Required, Default: USD
Default Value: USD
Represents the type of currency used for capture.
connectionType
Group: Authorization
SubGroup:
Type: String(30)
XML Representation: attribute
Attributes:
Constant, Required, Default: HTTPS
Default Value: HTTPS
Type of connectivity to use to exchange messages/files with a processor.
host
Group: Authorization
SubGroup:
Type: String(160)
XML Representation: attribute
Attributes:
Required, Default: https://xmltest.propay.com/API/PropayAPI.aspx
Default Value: https://xmltest.propay.com/API/PropayAPI.aspx
Host to be used for HTTPs based connectivity.
sslCertificateFileName
Group: Authentication Certificate
SubGroup:
Type: String(50)
XML Representation: attribute
Name of SSL certificate used for HTTP/HTTPs based communication.
sslPassword
Group: Authentication Certificate
SubGroup:
Type: String(100)
XML Representation: attribute
Password on the SSL certificate used for HTTP/HTTPs based communication.
connectionTypeSettlement
Group: Submission
SubGroup: Connectivity (Returns)
Type: String(30)
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: Submission
SubGroup: Connectivity (Returns)
Type: String(100)
XML Representation: attribute
Attributes:
Required, Default: ftp.mybank.com
Default Value: ftp.mybank.com
Host used for FTP/sFTP based connectivity.
portSettlement
Group: Submission
SubGroup: Connectivity (Returns)
Type: Integer
XML Representation: attribute
Attributes:
Required, Default: 22
Default Value: 22
Port used for FTP/sFTP based connectivity.
username
Group: Submission
SubGroup: Connectivity (Returns)
Type: String(50)
XML Representation: attribute
Attributes:
Required, Default: user
Default Value: user
Username used for HTTPs based connectivity.
password
Group: Submission
SubGroup: Connectivity (Returns)
Type: String(100)
XML Representation: attribute
Attributes:
Required, Encrypted, Default: pass
Default Value: pass
Password used for HTTPs based connectivity.
responsePath
Group: Submission
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.
Inbox
Attributes:
Required, Default: in
Default Value: in
Location where files are uploaded for processing.
keyNameSSH
Group: Submission
SubGroup: SSH
Type: String(100)
XML Representation: attribute
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
Passphrase of the private SSH key used for FTP/sFTP based connectivity.