UniPayCardsBatchProviderProfile

Type:  Struct
Abstract:  no
Status:  Active
Configuration settings for cards batch processing through Unipay CC
Avalible Field Groups:
type
Group: System
SubGroup:
Type: String(60)
XML Representation: attribute
References: Processing Profile.Type
Attributes: Constant, Required, Default: cards-batch/unipay
Default Value: cards-batch/unipay
Type of the Provider Profile. 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.
accountProcessingPolicy
Group: System
SubGroup:
Type: String(10)
XML Representation: attribute
References: Processing Profile.Account Processing Policy
Attributes: Required, Default: VMXD----*U
Default Value: VMXD----*U
Type of processing policy for the account.
retryAttemptsLimit
Group: System
SubGroup:
Type: Integer
XML Representation: attribute
References: CC Profile.Max Retry Attempt
Attributes: Default: 4
Default Value: 4
Number of attempts that soft declines are retried before the final decline is returned to the submitter.
retryInterval
Group: System
SubGroup:
Type: Integer
XML Representation: attribute
References: CC Profile.Retry Interval
Attributes: Default: 3
Default Value: 3
The number of days between subsequent to subsequent retry attempts.
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:
XML Representation: element
Attributes: Default: None
Default Value: None
authorizationCurrencyCode
Group: Merchant
SubGroup:
Type: String
XML Representation: attribute
References: Processing Profile.Authorization Currency Code CL
Attributes: Default: USD
Default Value: USD
Represents the type of currency used for authorization.
captureCurrencyCode
Group: Merchant
SubGroup:
Type: String
XML Representation: attribute
References: Processing Profile.Capture Currency Code CL
Attributes: Default: USD
Default Value: USD
Represents the type of currency used for capture.
accountId
Group: Merchant
SubGroup: General
Type: Integer
XML Representation: attribute
References: CC UniPay Profile.Provider Merchant Account Code
Attributes: Required
Code of Merchant Account to which instance of this object is attributed to. It is assigned by service provider. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code. The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
companyName
Group: Merchant
SubGroup: Descriptor
Type: String(3)
XML Representation: attribute
References: CC UniPay Profile.Company Name
Attributes:
Name of the merchant's company.
descriptor
Group: Merchant
SubGroup: Descriptor
Type: String(21)
XML Representation: attribute
References: CC UniPay Profile.Descriptor
Attributes:
Textual description of the record.
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
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: sampleUser
Default Value: sampleUser
Username used for HTTPs based connectivity.
password
Group: Submission
SubGroup: Connectivity
Type: String(100)
XML Representation: attribute
References: Provider Account.Password
Attributes: 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: Default: /in
Default Value: /in
Location where files are uploaded for processing.
requestPath
Group: Submission
SubGroup: Path
Type: String(100)
XML Representation: attribute
References: Provider Account.Outbox
Attributes: Default: /out
Default Value: /out
Location from which response files are downloaded for processing. If value is not defined, the responses are downloaded from the upload location.
keyNameSSH
Group: Submission
SubGroup: SSH
Type: String(100)
XML Representation: attribute
References: Provider Account.SSH Private Key File Name
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(100)
XML Representation: attribute
References: Provider Account.SSH Pass Phrase
Attributes: 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(100)
XML Representation: attribute
References: Provider Account.Encryption Private Key File Name
Attributes: 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(100)
XML Representation: attribute
References: Provider Account.Encryption Pass Phrase
Attributes: 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(100)
XML Representation: attribute
References: Provider Account.Encryption Public Key File Name
Attributes: 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.
keyExpirationDatePGP
Group: Submission
SubGroup: PGP
Type: Date
XML Representation: attribute
References: Provider Account.Encryption Expiration Date
Attributes: Default: 2015-01-25
Default Value: 2015-01-25
Expiration date of the private PGP key used for FTP/sFTP based connectivity.

XML Sample:

<profile/>

"<profile/>"

JSON Sample:

{
 
}

XURL Sample:

?