UniPay Gateway Documentation

type

Group: System

SubGroup:

Type: String(60)

XML Representation: attribute

References: Processing Profile.Type

Attributes: Constant, Required, Default: account-updater/tsys

Default Value: account-updater/tsys

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.

ownerType

Group: System

SubGroup:

Type: String

XML Representation: attribute

Attributes: Transient

accountProcessingPolicy

Group: System

SubGroup:

Type: String(10)

XML Representation: attribute

References: Processing Profile.Account Processing Policy

Attributes: Default: VMXD~~~~~~***

Default Value: VMXD~~~~~~***

Pattern:

Type of processing policy for the account.

aggregationFrequency

Group: System

SubGroup:

Type: String(1)

XML Representation: attribute

Attributes: Default: D

Default Value: D

Pattern:

groupSenderId

Group: Merchant

SubGroup: General

Type: String(32)

XML Representation: attribute

References: Account Updater Tsys Profile.Group Sender Id

Attributes:

Pattern:

merchantSenderId

Group: Merchant

SubGroup: General

Type: String(32)

XML Representation: attribute

References: Account Updater Tsys Profile.Merchant Sender Id

Attributes: Required

Pattern:

tsysAccountUpdateTransactionType

Group: Merchant

SubGroup: General

Type: Enum[]

XML Representation: attribute

References: Account Updater Tsys Profile.Transaction Type

Attributes: Required, Default: S

Default Value: S

connectionType

Group: Submission

SubGroup: Connectivity

Type: String(30)

XML Representation: attribute

References: Provider Account.Primary Connection Type

Attributes: Constant, Default: SFTP

Default Value: SFTP

Type of connectivity to use to exchange messages/files with a processor.

ftpHost

Group: Submission

SubGroup: Connectivity

Type: String(100)

XML Representation: attribute

References: Provider Account.FTP Host

Attributes: Required, Default: https://host.com

Default Value: https://host.com

Pattern:

Host used for FTP/sFTP based connectivity.

ftpPort

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

Pattern:

Username used for HTTPs based connectivity.

password

Group: Submission

SubGroup: Connectivity

Type: String(100)

XML Representation: attribute

References: Provider Account.Password

Attributes: Required, Encrypted

Pattern:

Password used for HTTPs based connectivity.

responsePath

Group: Submission

SubGroup: Path

Type: String(100)

XML Representation: attribute

References: Provider Account.Inbox

Attributes: Required

Pattern:

Location where files are uploaded for processing.

keyNameSSH

Group: Submission

SubGroup: SSH

Type: String(60)

XML Representation: attribute

References: Provider Account.SSH Private Key File Name

Attributes: Default: samplePrivateKey.ssh

Default Value: samplePrivateKey.ssh

Pattern:

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

Pattern:

Passphrase of the private SSH key used for FTP/sFTP based connectivity.

isOnDownloadDeleteRequired

Group: Merchant

SubGroup: General

Type: Boolean

XML Representation: attribute

References: Account Updater Tsys Profile.On Download Delete Required

Attributes: Default: true

Default Value: true

TsysAccountUpdaterProviderProfile

XML Sample:

JSON Sample:

XURL Sample: