UniPay Gateway Documentation

type

Group: System

SubGroup:

Type: String(60)

XML Representation: attribute

References: Processing Profile.Type

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

Default Value: account-updater/nab

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: VM~D~~~~*~

Default Value: VM~D~~~~*~

Type of processing policy for the account.

processExpiredCardOnlyPolicy

Group: System

SubGroup:

Type: String(4)

XML Representation: attribute

References: Account Updater Profile.Process Expired Card Only Policy

Attributes: Default: --X-

Default Value: --X-

aggregationFrequency

Group: System

SubGroup:

Type:

XML Representation: element

Attributes: Default: H

Default Value: H

cardProcessorName

Group: Payment Facilitator

SubGroup:

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Card Processor Name

Attributes: Required, Default: FIRSTDATA

Default Value: FIRSTDATA

Assigned by FDMS. FDMS will identify the Acquirer's Name.

visaAcquirerBin

Group: Payment Facilitator

SubGroup:

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Visa Acquirer Bin

Attributes: Required, Default: 123654

Default Value: 123654

Assigned by FDMS. FDMS will identify the Visa Acquirer BIN.

masterCardICA

Group: Payment Facilitator

SubGroup:

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Master Card Ica

Attributes: Required, Default: 000025

Default Value: 000025

Assigned by FDMS. FDMS will identify the M/C Acquirer ICA

discoverPid

Group: Payment Facilitator

SubGroup: Discover

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Discover PID

Attributes: Default: 12345

Default Value: 12345

Discover Processor ID. FDMS will identify the Discover PID

discoverSe

Group: Payment Facilitator

SubGroup: Discover

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Discover Se

Attributes: Default: 12345

Default Value: 12345

Discover SE Number is required if Discover, Diners or JCB cards are present in the file, otherwise space fill.

discoverMailboxId

Group: Payment Facilitator

SubGroup: Discover

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Discover Mailbox ID

Attributes: Default: R

Default Value: R

Discover Mailbox Destination ID
R- RSA
W-Wells

isTestMode

Group: Merchant

SubGroup:

Type: Boolean

XML Representation: attribute

References: Account Updater FirstData Profile.Is Test Mode

Attributes: Default: false

Default Value: false

Indicates whether the test mode is active for the record in the system.

merchantName

Group: Merchant

SubGroup:

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Merchant Name

Attributes: Required

Assigned by FDMS.

merchantNumber

Group: Merchant

SubGroup:

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Merchant Number

Attributes: Required

Assigned by FDMS.

fileName

Group: Settings

SubGroup:

Type: String(255)

XML Representation: attribute

References: Account Updater FirstData Profile.Filename

Attributes: Required, Default: ABCDEFGH

Default Value: ABCDEFGH

The name given to a file in order to distinguish it from other files.

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: sftp://nabclient.com

Default Value: sftp://nabclient.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.

requestPath

Group: Submission

SubGroup: Path

Type: String(100)

XML Representation: attribute

References: Provider Account.Outbox

Attributes: Required, Default: outbox

Default Value: outbox

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: Required, Default: inbox

Default Value: inbox

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: Required, 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: Required, 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: Required, 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: Required, Encrypted, Default: passPhrase85$

Default Value: passPhrase85$

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: Required, Default: merchant-public.asc

Default Value: merchant-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.

ownerType

Group: System

SubGroup:

Type: String

XML Representation: attribute

Attributes: Transient, Default: None

Default Value: None

NabAccountUpdaterProviderProfile

XML Sample:

JSON Sample:

XURL Sample: