Parameter Description

Data Type

Description

A

Alpha only (A-Za-z)

AN

Alphanumeric (a-zA-Z0-9)

Base64

Base64 encryption of binary data

Boolean

True or False

Guid

Globally Unique Identifier: {[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}
(eg {8E51611F-E19A-4FF0-B229-6A69F42AAA62})

Hex

Hex (0-9A-Fa-f)

N

Numeric (Positive integer)

N.

Digits and dots (.) (e.g's 4242........4242, 1.0)

N:

Digits and colons

String

ANPS Free format string containing: Alpha, numeric, special and padding (printable ASCII)

Z

Positive or negative integer

Node Type

Set input parameter value

Get output parameter value

attribute

enterprise.setAttribute(..)

enterprise.getAttribute(..)

tag

enterprise.setTag(..)

enterprise.getTag(..)

parameter

enterprise.prepare(...)

N/A

attribute parameter

enterprise.prepare(...)

enterprise.getAttribute(..)

property

Use method or property of enterprise corresponding to the parameter

N/A

subtag

call enterprise.setTag(..) within
   enterprise.openElement(...)
   ...
   enterprise.closeElement()

N/A

Core Parameters

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

ApplicationID

attribute parameter

Guid

38

38

Identification of the merchant’s configuration within the iVeri Gateway

CertificateID

property

Guid

38

38

The iVeri CertificateID installed on the server communicating with the iVeri Gateway

CertificatePath

property

A

Valid Path to directory where the KeyStoreFile or CertificateFile exists on the filesystem

CertificateFile

property

A

Existing certificate file

CertificatePassword

property

A

Password of the certificate

Gateway

property

A

10

The name of the gateway connecting to. If not explicitly set, the default gateway is used.

Command

attribute parameter

A

50

The command specifying what should be done by the iVeri Gateway

Mode

attribute parameter

A

4

4

The mode of the corresponding ApplicationID. See section 10.2

RequestID

attribute

Guid

38

38

A unique identifier generated by the iVeri Gateway for this request

Category

parameter

A

50

A categorisation of the request. Only required in conjunction with a prepare method.

Common Parameters

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

Acquirer

tag

A

3

32

The Acquiring system to which this transaction was routed by iVeri

AcquirerDate

tag

N

8

8

The date that the Acquirer allocated to this transaction

YYYYMMDD

YearMonthDay

AcquirerReference

tag

N:

64

A reference allocated by the Acquirer to this transaction with format specific to the acqiurer. It is a composite element consisting of a settlement cycle and a transaction trace. The cycle can be 5 digits (the acquirer batch number) or 8 digits (cycle end date). The trace is the significant part of the acquirer Retrieval Reference Number (RRN). The trace can be 8 digits (if the RRN starts with 0000) or 12 digits (the full RRN).

AcquirerTime

tag

N

6

The time that the Acquirer allocated to this transaction

HHMMSS

HourMinuteSecond

Amount

tag

N

0

12

The total value of the transaction in the smallest unit of the currency specified (eg in cents)

AuthorisationCode

tag

AN

0

6

The Authorisation Code issued by the Issuer to the Merchant either telephonically or electronically

BudgetPeriod

tag

N

0

2

The number of months over which the cardholder would like to pay the transaction off. See section 10.4

CardSecurityCode

tag

N

3

4

The 3 or 4 digits printed on the card which are not contained on the magnetic strip. Usually printed after the CCNumber on the signature strip. Corresponds to American Express CIV, MasterCard CVC2 and VISA CVV2.  Does not exist within Associations

Currency

tag

A

3

The ISO 4217 currency code of the value of the transaction. e.g. USD or ZAR or GBP

DisplayAmount

tag

String

30

The Amount returned in a currency aware printable format

ExpiryDate

tag

N

4

6

The last month of the validity period of the card

CardholderName

tag

String

50

The name of the cardholder as embossed on the card.

CardholderEmail

tag

String

125

The email address of the cardholder

OrderDescription

tag

String

250

A brief description of the purchase made by the cardholder

AllowBudgetPeriod

tag

Boolean

When this is true a ‘BudgetPeriod’ input field will be present on the CardDetails capture form.

RequestExpiryDate

tag

N

8

8

The date after which the debit request will expire

YYYYMMDD

YearMonthDay

CreateTransactionUrl

tag

Boolean

When this value is ‘true’ a ‘TransactionUrl’ will be returned to the merchant. If ‘false’ a debit request email will be sent to the ‘CardholderEmail’

TransactionUrl

tag

String

225

The transaction url that the Cardholder must be redirected to perform a transaction when the command was ‘RequestForDebit’. This will be returned to the merchant in the response if the ‘CreateTransactionUrl’ parameter is set to ‘true’

MerchantName

tag

String

50

The merchant name associated with the ApplicationID

MerchantAddress

tag

String

50

The merchant address associated with the ApplicationID

MerchantCity

tag

String

50

The merchant city associated with the ApplicationID

MerchantCountryCode

tag

String

2

The merchant country code associated with the ApplicationID

MerchantCountry

tag

String

50

The merchant country name associated with the ApplicationID

MerchantReference

tag

String

0

64

A merchant generated identifier that is unique within a specified time period that identifies a transaction sequence.  In the case that the transaction is an Authenticated Collection this field will contain the 14-character long Contract Reference allocated by the Merchant for this transaction.

OriginalMerchantReference

tag

String

0

64

A merchant generated identifier of a previous transaction used in a Tokenized PAN transaction

MerchantTrace

tag

String

0

64

Unique merchant identification for the request

MerchantUSN

tag

String

0

15

The merchant USN associated with the ApplicationID

OriginalMerchantTrace

tag

String

64

A reference to the original MerchantTrace previously sent to the iVeri Gateway

OriginalRequestID

tag

Guid

38

38

The RequestID that was returned as part of the original transaction

PAN

tag

N..

20

Primary Account Number (eg Credit card number), may have been extracted from Track2. When this is an output parameter, then a section of it is dotted out, and safe to display or print

PANMode

tag

String

0

128

The mechanism by which the PAN was determined from the card. The value is a comma separated list of the following:

PurchaseDate

tag

4

4

The date on which the purchase was made. Defaults to current Date

MMDD

MonthDay

PurchaseTime

tag

4

4

The time at which the purchase was made. Defaults to current Time

HHMM

HourMinute

ReconReference

tag

N

0

8

Identifier that the Merchant is returned during a transaction and that also appears in the reconciliation information supplied by the Acquirer. Either assigned by the iVeri Gateway or derived from the specified MerchantReference.

StartDate

tag

A

6

The date of the start of the validity period of the card number. The start date is not available on many cards, and will remain an optional parameter until the start date becomes more common

Terminal

tag

N

0

8

Identifier optionally allocated by the merchant which is intended to group transactions together for reporting purposes in reconciliation statements.

Track2

tag

String

39

Track2 after being read by the swipe device from the magnetic stripe on the card (for card present transactions). It is inclusive of the beginning and end markers being ; and ? respectively. See section 10.3

TransactionIndex

tag

Guid

38

38

Unique identifier allocated by iVeri for a series of related transactions. If PANFormat is 'TransactionIndex', TransactionIndex is used to locate a previous transaction for the PAN to be resolved.

               ForeignRetailIndicator

tag

AN

​

​

 Possible Values: Local or Foreign

MSISDN

tag

String

A mobile number required by PANFormat “MSISDN” transactions

VisaCheckoutCallID

tag

String

0

48

Visa Checkout transaction ID associated with a payment request.

MasterPassTransactionID

tag

N

This is the MasterPass system transaction reference

ForeignAmount

Tag

String

0

11

When doing a transaction in a foreign currency we need to specify the amount here in the foreign currency

Mandatory when doing transaction in foreign currency

ForeignCurrency

Tag

String

3

3

When doing a transaction in a foreign currency we need to specify the foreign currency here

Mandatory when doing transaction in foreign currency

ForeignExchangeID

Tag

Guid

38

38

Unique Identifier returned in the DynamicCurrencyConversion / MultiCurrencyPricing linked to the BaseAmount /BaseCurrency and the Amount and Currency in the current transaction request

Mandatory when doing transaction in foreign currency

PANFormat

tag

String

An enumeration specifying how to obtain the PAN details

PAN

Required tag: PAN. If PANFormat is not specified, this value is used if the PAN tag is set and the Track2 tag not set.

Track2

Required tag: Track2. If PANFormat is not specified, this value is used if the Track2 tag is set.

TransactionIndex/ OriginalMerchantReference/

Required tags: PAN and one of TransactionIndex or OriginalMerchantReference. The PAN is the dotted-out number of the card used with the original transaction. The full PAN is looked up using the given identifier for the original transaction.

VisaCheckoutCallID

Required tags:  VisaCheckoutCallID

The VisaCheckoutCallID is used to retireve the Payment Data from the Visa Checkout Process.

MSISDN

Required tag: MSISDN. If in addition, AccountType, PAN (full) and ExpiryDate are provided, the transaction also serves as a registration of the MSISDN, thereby enabling future transactions with MSISDN only.

CardHolderPresence

tag

String

0

128

Specify how the cardholder is involved when a virtual transaction is performed. This tag supersedes the ElectronicCommerceIndicator tag. The value is a comma separated list of the following:

Card Detail Parameters

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

Association

tag

String

0

50

The association to which the card number belongs e.g. VISA or Master card or American Express

BIN

tag

N

1

9

The Bank Identification Number into which PANs are grouped. Generally, this is the first two to eight digits

CardType

tag

String

0

50

A description of the type of the card used e.g. Credit Card, Maestro, Electron etc

Issuer

tag

String

0

50

If the card is local this gives a description of the institution that issued this particular card

Jurisdiction

tag

String

0

50

Description of whether the card is a local or international card

Result Parameters

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

Code

attribute

N

3

The numeric Result Code of the completed execution. See section 10.1

Description

attribute

String

1024

A description of the results of the completed execution. Only relevant where ResultStatus is 'Unsuccessful' [-1] or 'Successful with warning' [1]

Source

attribute

String

128

The source of the result

Previous

attribute

Boolean

In most cases returns false, indicating that the other result values refer to the immediately completed execution. For advanced usage within a Reprint, to indicate whether the result returned refers to the current execution, or a previous execution.

Status

attribute

Z

2

The status of the completed execution

3DSecure Parameters

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

ElectronicCommerceIndicator

tag

A

0

More commonly known as the ECI, it describes for virtual transactions what steps were taken to secure and authenticate the transaction. Values are the following subset of CardHolderPresence values: ThreeDSecure, ThreeDSecureAttempted, SecureChannel and ClearChannel.

CardHolderAuthenticationData

tag

Base64

28

28

For usage with Verified by Visa / MasterCard SecureCode. The CAVV or UCAF field depending on whether the card is VISA or Master card. Note: Original binary format length = 20 bytes. Mandatory when ElectronicCommerceIndicator = ThreeDSecure

CardHolderAuthenticationID

tag

Base64

28

28

For usage with Verified by Visa / MasterCard SecureCode. The Transaction ID. Note: Original binary format length = 20 bytes. Mandatory when ElectronicCommerceIndicator = ThreeDSecure

ThreeDSecure_RequestID

tag

Guid

38

The RequestID that was returned as part of the Enrollment Check that will be used to retrieve data for the Authentication Validation

ThreeDSecure_ACS_URL

tag

URL

No Limit

URL of the Access Control Server of the card-issuing bank where you need to send the ThreeDSecure_PAReq so that the customer can be authenticated.. The field length can be very large.

ThreeDSecure_PAReq

tag

Base64

No Limit

Digitally signed payer authentication request message that contains a unique transaction ID.The field length can be very large.

ThreeDSecure_SignedPARes

tag

Base64

No Limit

Digitally signed PARes message that contains the authentication result.The field length can be very large.

ThreeDSecure_VEResEnrolled

tag

A

1

1

Indicator that shows whether the cardholder is participating in 3DS.

UPOP SecurePlus Parameters

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

UPOP_TransactionTime

tag

String

The time when the Merchant sends the transaction.

Date and time formatted as an ISO 8601 combined date and time string using the extended format.

            - Format: YYYY-MM-DDThh:mm:ssZ

              - YYYY = year

              - MM = month

              - DD = day

              - hh = hour

              - mm = minutes

              - ss = seconds

UPOP_RelatedTransactionType

tag

String

2

2

Related Transaction Type. One of:

              - Purchase

              - Pre-authorization

              The corresponding UnionPay protocol values are:

              - 01: Purchase

              - 02: Pre-authorization

UPOP_RequestID

tag

Guid

38

The RequestID that was returned as part of the Request Creation that will be used to retrieve data for the Authentication Validation

UPOP_FrontUrl

tag

URL

256

UPOP send the transaction result notification to the URL via cardholder’s browser

UPOP_BackUrl

tag

URL

256

UPOP send the transaction result notification to the URL via system

UPOP_ACPReq

tag

Base64

No Limit

The Authentication Request message to be posted to the UPOP authentication server

UPOP_Endpoint

tag

URL

The UPOP authentication server endpoint where the Authentication Request message must be posted via cardholder’s browser

UPOP_ACPRes

tag

Base64

No Limit

The Authentication Response message received from the UPOP authentication server

POS Parameters 

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

DeviceFirmware

tag

String

64

The firmware (software) currently loaded on the device. This may be set as an integer

DeviceFirmwareVersion

tag

String

64

The version of the firmware (software) currently loaded on the device.

DevicePINKey

tag

Hex

32

32

Master/Session encryption specific: The device PIN Key encrypted under the device master key i.e. DMK(DPK)

MACDevicePINKey

tag

Hex

8

8

Master/Session encryption specific: The MAC of the device PIN Key i.e. MAC(DPK)

AccountType

tag

A

0

32

The type of account that this transaction relates to (known to the cardholder)

AvailableBalance

tag

N

12

The available amount in the cardholders account given in the smallest unit of currency of the cardholder (not necessarily the currency of the merchant)

DisplayAvailableBalance

tag

String

25

The AvailableBalance returned in a currency aware printable format

CashAmount

tag

N

12

The Cash (back) portion of the Amount. Subject to the constraint: 0 <= CashAmount <= Amount

CurrentBalance

tag

Z

12

The current balance in the cardholders account given in the smallest unit of currency of the cardholder (not necessarily the currency of the merchant)

DisplayCurrentBalance

tag

String

25

The CurrentBalance returned in a currency aware printable format

DeviceMake

tag

String

64

The manufacturer of the device (terminal). e.g. Dione / Sagem

DeviceSerialNumber

tag

String

64

The serial number of the device (terminal)

DeviceCycle

tag

String

20

The current batch id of the device (terminal)

PINBlock

tag

Hex

16

16

The cardholders PIN encrypted using the current device pin key

KeySerialNumber

tag

Hex

20

20

DUKPT encryption specific: Mandatory input parameter needed in decryption of a DUKPT PINBlock.

Track2KeySerialNumber

tag

Hex

20

20

DUKPT Track2 encryption specific: Mandatory input parameter needed in decryption of a DUKPT Track2.

PANKeySerialNumber

tag

Hex

20

20

DUKPT PAN encryption specific: Mandatory input parameter needed in decryption of a DUKPT PAN.

EMV Parameters

EMV_AuthorisationRequestCryptogram

tag

Hex

16

EMV tag 9F26

EMV_ApplicationIdentifier

tag

Hex

32

EMV tag 9F06

EMV_ApplicationInterchangeProfile

tag

Hex

4

EMV tag 82

EMV_CardSequenceNumber

tag

Hex

2

EMV tag 5F34

EMV_ApplicationTransactionCounter

tag

Hex

4

EMV tag 9F36

EMV_ApplicationVersion

tag

Hex

4

EMV tag 9F08

EMV_CardHolderVerificationMethodResult

tag

Hex

6

EMV tag 9F34

EMV_CryptogramInformationData

tag

Hex

2

EMV tag 9F27

EMV_IssuerApplicationData

tag

Hex

64

EMV tag 9F10

EMV_TerminalCapabilities

tag

Hex

6 or 8

EMV tag 9F33

EMV_TerminalType

tag

N

2

EMV tag 9F35

EMV_TransactionType

tag

N

2

EMV tag 9C

EMV_TerminalVerificationResult

tag

Hex

10

EMV tag 95

EMV_UnpredictableNumber

tag

Hex

8

EMV tag 9F37

EMV_TransactionStatusInformation

tag

Hex

4

EMV tag 9B

EMV_IssuerAuthenticationData

tag

Hex

16 or 32

EMV tag 91

EMV_IssuerScriptTemplate1

tag

Hex

999

EMV tag 71

EMV_IssuerScriptTemplate2

tag

Hex

999

EMV tag 72

EMV_ResponseCode

tag

AN

2

EMV tag 8A

Procurement Parameters 

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

CustomerReferenceIdentifier

tag

AN

17

Description allocated by the merchant to be printed on the Cardholders statement

CustomerVATRegistrationNumber

tag

AN

13

The VAT registration number of the Customer if available

DestinationCountry

tag

A

2

2

The ISO code for the country of residence of the Merchant. e.g. ZA, US, GB

DestinationZIPCode

tag

AN

0

10

The Customers Destination ZIP code

NationalTax

tag

N

0

12

The VAT amount of the transaction in the currency's smallest denomination. Depending on the NationalTaxIndicator this may be included or in addition to the Amount field

NationalTaxIndicator

tag

N

0

1

Indicates whether VAT is applicable to this transaction.

OrderDate

tag

A

0

6

The date that the order was placed. This is not necessarily the same as the PuchaseDate. Defaults to current Date

YYMMDD

YearMonthDay

PurchaseIdentifier

tag

AN

0

25

Optional description allocated by the Merchant to be displayed on the Merchants statement.  Defaults to MerchantReference.

ShipFromZIPCode

tag

AN

0

10

The ZIP code of the Merchant (Shipping source ZIP code)

ShippingAmount

tag

N

0

12

The amount charged to the customer for shipping charges in the currency's smallest denomination.

ShippingTaxRate

tag

0

4

The VAT rate that applies to the ShippingAmount. It is a percentage and not the actual value. The value is the rate multiplied with 10000.

TransactionDiscount

tag

N

0

12

Discount value for the transaction as a whole, it is the result of individual line item percentage discounts applied to line items. In the currency’s smallest denomination

UniqueVATInvoiceReferenceNumber

tag

AN

0

15

The invoice number allocated by the merchant and appears on the merchant’s invoice given to the customer. This is an optional field is independent of the Merchant Reference.

Procurement LineItem Parameters 

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

Discount

subtag

N

0

12

The total discount for the line item in the currency's smallest denomination.

ItemCommodityCode

subtag

N

0

4

The ISO commodity code for the line item unit.

ItemDescriptor

subtag

N

0

26

A description for the line item unit.

ProductCode

subtag

AN

0

12

The merchant's code for the line item unit.

Quantity

subtag

N

0

8

The total number of line item units.

TaxRate

subtag

N

0

4

The VAT rate applicable to the line item. The value is the rate multiplied with 10000.

Total

subtag

N

0

12

The total amount for the line item in the currency's smallest denomination. The value equals Quantity x UnitCost - Discount.

UnitCost

subtag

N

0

10

The cost of a line item unit in the currency's smallest denomination.

UnitOfMeasure

subtag

AN

0

12

The measurement unit description.

PassengerFirstName

subtag

AN

0

60

Passenger's first name.

PassengerLastName

subtag

AN

0

60

Passenger's last name

PassengerID

subtag

AN

0

32

 ID of the passenger to whom the ticket was issued. For example, you can use this field for

the frequent flyer number

PassengerStatus

subtag

AN

0

32

Your company's passenger classification, such as with a frequent flyer program. In this case,

you might use values such as standard, gold, or platinum.

PassengerType

subtag

AN

0

32

Passenger classification associated with the price of the ticket. You can use one of the

following values:

•                 ADT: Adult

•                 CNN: Child

•                 INF: Infant

•                 YTH: Youth

•                 STU: Student

•                 SCR: Senior Citizen

•                 MIL: Military

Note: The fields in Blue will only be used when doing CyberSource Advanced Fraud Screening.

Fleet Parameters 

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

CustomerReferenceIdentifier

tag

AN

8

Contains two subfields, and is in the format: “Type” + “Odometer Reading”

Fleet  LineItem  Parameters  (see section Error: Reference source not found)

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Description

ProductCode

subtag

AN

0

64

The iVeri Product Code for the Fleet LineItem. The latest set of iVeri Fleet Product Codes can be obtained via the Inventory download command (Only use the ProductCodes with Type='Fleet'). The set at time of writing is provided here.

Quantity

subtag

N

0

8

The total number of line item units

QuantityDecimalPlaces

subtag

N

0

4

The number of implied decimals in the Quantity

UnitCost

subtag

N

0

10

The cost of a line item unit in the currency's smallest denomination