UniPay Gateway Documentation

type

Group: System

SubGroup:

Type: String

XML Representation: attribute

References: Processing Profile.Type

Attributes: Constant, Required, Default: ach-realtime/unipay

Default Value: ach-realtime/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.

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.

accountProcessingPolicy

Group: System

SubGroup:

Type: String

XML Representation: attribute

References: Processing Profile.Account Processing Policy

Attributes: Default: VMXDN----U

Default Value: VMXDN----U

Type of processing policy for the account.

accountId

Group: Merchant

SubGroup: General

Type: Integer

XML Representation: attribute

References: EFT UniPay Profile.Provider Merchant Account Code

Attributes: Required, Default: 2001

Default Value: 2001

Code of Merchant Account to which instance of this object is attributed to. It is assigned by a 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.

authorizationCurrencyCode

Group: Merchant

SubGroup: General

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: General

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.

companyName

Group: Merchant

SubGroup: Descriptor

Type: String

XML Representation: attribute

References: EFT UniPay Profile.Company Name

Attributes: Default: Company123

Default Value: Company123

Name of the merchant's company.

descriptor

Group: Merchant

SubGroup: Descriptor

Type: String

XML Representation: attribute

References: EFT UniPay Profile.Descriptor

Attributes: Default: desc123

Default Value: desc123

Textual description of the record.

host

Group: Authorization

SubGroup:

Type: String

XML Representation: attribute

References: Provider Account.Http Host

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

Default Value: https://unipay.com

Host to be used for HTTPs based connectivity.

username

Group: Authorization

SubGroup:

Type: String

XML Representation: attribute

References: EFT UniPay Profile.User Name

Attributes: Required, Default: user1000

Default Value: user1000

password

Group: Authorization

SubGroup:

Type: String

XML Representation: attribute

References: EFT UniPay Profile.Password

Attributes: Required, Encrypted, Default: pass1000

Default Value: pass1000

UniPayACHRealtimeProviderProfile

XML Sample:

JSON Sample:

XURL Sample: