type
Type: String(60)
XML Representation: attribute
References: Processing Profile.
Type
Attributes:
Constant, Required, Default: cards-realtime/propay
Default Value: cards-realtime/propay
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.
accountNum
Group: Merchant
SubGroup: General
Type: Integer
XML Representation: attribute
Attributes:
Required, Default: 12345678901
Default Value: 12345678901
Bank account number. Required if adding bank account info as part of the signup.
certStr
Group: Merchant
SubGroup: General
Type: String(30)
XML Representation: attribute
References: Retail Propay Profile.
Cert Str
Attributes:
Required, Encrypted, Default: 12345678901PASS
Default Value: 12345678901PASS
authorizationCurrencyCode
Group: Merchant
SubGroup: General
Type: Enum(3)
XML Representation: attribute
Attributes:
Required, Default: USD
Default Value: USD
Represents the type of currency used for authorization.
captureCurrencyCode
Group: Merchant
SubGroup: General
Type: Enum(3)
XML Representation: attribute
Attributes:
Required, Default: USD
Default Value: USD
Represents the type of currency used for capture.
connectionTypeAuthorization
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.
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: sampleUser
Default Value: sampleUser
Username used for HTTPs based connectivity.
password
Group: Submission
SubGroup: Connectivity (Returns)
Type: String(100)
XML Representation: attribute
Attributes:
Required, Encrypted, Default: samplePassword
Default Value: samplePassword
Password used for HTTPs based connectivity.
responsePath
Group: Submission
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.
Inbox
Attributes:
Required, Default: outbox
Default Value: outbox
Location where files are uploaded for processing.
authorizationExpirationPeriod
Type: Integer
XML Representation: attribute
The number of days from the transaction request day that the unconfirmed authorization can remain unreversed even if settlement process occurs. When settlement happens and the transaction authorization period is not being reached (transaction is not expired), transaction is transfered into the next retail cycle.
Number of days during which an authorization can remain unsettled. When the value is greater than 0, any un-captured (unconfirmed) transactions will not be reversed until the expiration period is reached.
Note: the value of the expiration period cannot exceed the lifetime of an authorization allowed by the processor that was used to get it.
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.
creditProcessingMode
Type: Enum
XML Representation: attribute
Attributes:
Required, Default: CR
Default Value: CR
Represents the type of credit policy supported for this profile.
