UniPay Gateway Documentation

type

Group: System

SubGroup:

Type: String

XML Representation: attribute

Attributes: Constant, Required, Default: ach/vectra-bank

Default Value: ach/vectra-bank

Type of the vectrabank.

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.

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.

companyName

Group: Merchant

SubGroup: General

Type: String

XML Representation: attribute

References: EFT NACHA Profile.Company Name

Attributes: Required, Default: Sample Merchant

Default Value: Sample Merchant

Name of the company that originates transactions.

saleCompanyId

Group: Merchant

SubGroup: General

Type: String

XML Representation: attribute

References: EFT NACHA Profile.Sale Company ID

Attributes: Required, Default: 8000663400

Default Value: 8000663400

ID of the company (originator of the transaction) assigned by the bank to process sales.

immediateOrigin

Group: Merchant

SubGroup: General

Type: String

XML Representation: attribute

References: EFT NACHA Profile.Immediate Origin

Attributes: Required, Default: 1234567890

Default Value: 1234567890

Assigned by provider (it seems this field is linked to routing number)

contactName

Group: Merchant

SubGroup: General

Type: String

XML Representation: attribute

References: EFT NACHA Profile.Contact Name

Attributes: Required, Default: SampleName

Default Value: SampleName

Name of the person to contact with processing issues.

description

Group: Merchant

SubGroup: Descriptor

Type: String

XML Representation: attribute

References: EFT NACHA Profile.Description

Attributes: Required, Default: SampleItem

Default Value: SampleItem

Descriptor that will appear on the cardholder’s statement. If this field is blank the descriptor is reset to the default at the division level.

contactPhoneNumber

Group: Merchant

SubGroup: Descriptor

Type: String

XML Representation: attribute

References: EFT NACHA Profile.Contact Phone Number

Attributes: Required, Default: (303)952-2016

Default Value: (303)952-2016

Phone number of the person to contact with processing issues.

connectionType

Group: Submission

SubGroup: Connectivity

Type: String

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

XML Representation: attribute

References: Provider Account.FTP Host

Attributes: Required

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

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

XML Representation: attribute

References: Provider Account.Password

Attributes: Encrypted

Password used for HTTPs based connectivity.

requestPath

Group: Submission

SubGroup: Path

Type: String

XML Representation: attribute

References: Provider Account.Outbox

Attributes: Default: /in

Default Value: /in

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

XML Representation: attribute

References: Provider Account.Inbox

Attributes: Default: /out

Default Value: /out

Location where files are uploaded for processing.

hostVerification

Group: Verification

SubGroup: Connectivity

Type: String

XML Representation: attribute

References: Provider Account.SMTP Host

Attributes: Required, Default: smtp.host.com

Default Value: smtp.host.com

Host used for SMTP based connectivity.

portVerification

Group: Verification

SubGroup: Connectivity

Type: Integer

XML Representation: attribute

References: Provider Account.SMTP Port

Attributes: Required, Default: 443

Default Value: 443

Port used for SMTP based connectivity.

usernameVerification

Group: Verification

SubGroup: Connectivity

Type: String

XML Representation: attribute

References: Provider Account.SMTP Username

Attributes: Required, Default: sampleUser

Default Value: sampleUser

Username used for SMTP based connectivity.

passwordVerification

Group: Verification

SubGroup: Connectivity

Type: String

XML Representation: attribute

References: Provider Account.SMTP Password

Attributes: Encrypted, Default: samplePassword

Default Value: samplePassword

Password used for SMTP based connectivity.

encryptionTypeVerification

Group: Verification

SubGroup: Connectivity

Type: String

XML Representation: attribute

References: Provider Account.SMTP Encryption CL

Attributes: Required, Default: N

Default Value: N

Enumeration of possible encryption modes used for SMTP based connectivity.

fromVerification

Group: Verification

SubGroup: Path

Type: String

XML Representation: attribute

References: Provider Account.SMTP From

Attributes: Required, Default: from

Default Value: from

List of From address used for SMTP based connectivity.

toVerification

Group: Verification

SubGroup: Path

Type: String

XML Representation: attribute

References: Provider Account.SMTP To

Attributes: Required, Default: to

Default Value: to

List of To addresses used for SMTP based connectivity.

VectraBankACHProviderProfile

XML Sample:

JSON Sample:

XURL Sample: