Parameter Description

Parameter 

Node Type 

Data Type 

Min Length 

Max Length 

Description 

ApplicationID 

Attribute 

parameter 

GUid 

38 

38 

Identification of the merchant’s configuration within the iVeri Gateway 

CertificateID 

property 

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 

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

RequestID 

Attribute 

38 

38 

A unique identifier generated by the iVeri Gateway for this request 

Mode 

Attribute 

parameter 

4 

4 

The mode of the corresponding ApplicationID. See section 10.2 

TEST  

LIVE 

Category 

parameter  

50 

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

Transaction 

use if Command = 'Debit' or 'Credit' or 'Authorisation' or 'AuthorisationReversal' or 'Void' 

Enquiry 

use if Command = 'Balance', 'PAN' or 'PANToken' or ' 

‘AuthenticatedCollection' or ‘RequestForDebit’ OR  ‘AccountValidation’ 

System 

use if Command = 'Ping' 

Security 

use if Command = 'GetDevicePINKey' 

Command 

Attribute 

parameter 

A 

The command specifying what should be done by the iVeri Gateway 

GetDevicePINKey 

Get DevicePINKey (use Category='Security') 

Ping 

Ping (use Category='System') 

Authorisation 

Authorisation (use Category='Transaction') 

AuthorisationReversal 

Authorisation Reversal (use Category='Transaction') 

Credit 

Credit (use Category='Transaction') 

Debit 

Debit (use Category='Transaction') 

Void 

Void (use Category='Transaction') 

Balance 

Balance Enquiry (use Category='Enquiry') 

PAN 

PAN Enquiry (use Category='Enquiry') 

PANToken 

PANToken Enquiry (use Category='Enquiry') 

AuthenticatedCollection 

AuthenticatedCollection:Enquiry (use Category='Enquiry') 

AccountValidation 

AccountValidation Enquiry (use Category = ‘Enquiry’) 

RequestForDebit 

RequestForDebit Enquiry (use Category = ‘Enquiry’) 

MasterPassQuickResponseCode 

MasterPass QuickResponseCode Enquiry (use Category = ‘Enquiry’) 

DynamicCurrencyConversion 

DynamicCurrencyConversion 

Parameter 

Node Type 

Data Type 

Min Length 

Max 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 

string 

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 card 

Jurisdiction 

Tag 

String  

0 

50  

Description of whether the card is a local or international card 

Parameter 

Node Type 

Data Type 

Min Length 

Max 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 

Tage 

A 

1 

1 

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

Parameter 

Node Type 

Data Type 

Min Length 

Max 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  

138 

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 

-1 

Unsuccessful 

0 

Successful 

1 

Successful, with warning 

Parameter 

Node Type 

Data Type 

Min Length 

Max Length 

Description 

Currency 

Subtag  

A 

3 

3 

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

Amount 

subTag 

N 

0 

11 

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

ForeignExchange 

Tag 

AN 

Contains a collection of ForeignExchangeItems 

Parameter 

Node Type 

Data Type 

Min Length 

Max 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 

Parameter 

Node Type 

Data Type 

Required/Optional  

Max Length 

Description 

DeliveryMethod 

subTag 

0 

O 

255 

Physical or Virtual 

DeviceFingerprintID 

SubTag 

AN 

0 

88 

Session ID for the fingerprint. 

BillTo_FirstName 

SubTag 

AN 

R 

60 

First name of cardholder 

BillTo_LastName 

SubTag 

AN 

R 

60 

Last name of cardholder 

BillTo_Street 

subTag 

AN 

R 

60 

Street address of cardholder 

BillTo_City 

subTag 

AN 

R 

60 

Billing city for cardholder 

BillTo_State 

subTag 

AN 

0 

2 

State or province of the cardholder. Required for U.S. and Canada. 

Use the two-character state, province, or territory codes. 

BillTo_Country 

subTag 

AN 

R 

2 

Billing country for cardholder. Use the two-character country codes. 

BillTo_PostalCode 

subTag 

AN 

O 

10 

 Postal code of the billing address. Required only if the BillTo_Country field is US or CA 

BillTo_Email 

subTag 

AN 

R 

100 

Email address of the cardholder 

BillTo_IPAddress 

subTag 

AN 

O 

15 

 IP address of the cardholder as reported by your Web server via socket information. 

Note: If any of the fields marked in Red is unavalable all the fields in Red will be replaced with defaults specified by CyberSource 

Parameter 

Node Type 

Data Type 

Min Length 

Max 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 

Cheque  

Not specified  

Savings 

Credit  

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 

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

Parameter 

Node Type 

Data Type 

Min Length 

Max Length 

Description 

EMV_AuthorisationRequestCryptogram 

Tag 

Hex 

16 

EMV tag 9F26 

EMV_ApplicationIdentifier 

Tag 

Hex 

32 

EMV tag 9F26 

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

Parameter 

Node Type 

Data Type 

Min Length 

Max 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. 

0 

NationalTax is NOT included 

1 

NationalTax is included 

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 

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, 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. 

Parameter 

Node Type 

Data Type 

Min Length 

Max 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 

12 

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 

our 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. 

Parameter 

Node Type 

Data Type 

Min Length 

Max Length 

Description 

PassengerName 

subTag 

AN 

0 

60 

Passenger's first name. 

PrimaryTicketNumber 

subTag 

AN 

0 

60 

FirstDepartureLocationCode 

subTag 

AN 

0 

32 

FirstArrivalLocationCode 

subTag 

AN 

0 

32 

OfficeIATANumber 

subTag 

AN 

0 

32 

OrderNumber 

PlaceOfIssue 

DepartureDate 

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

CompleteRoute 

DepartureTime 

JourneyType 

Parameter 

Node Type 

Data Type 

Required/Optinal   

Max Length 

Description 

AccountNumber 

subTag 

AN 

R  

19 

The account number that the payor is agreeing to allow the payee debit. 

DebtorIdentification 

SubTag 

AN 

R 

35 

Some data to identify the payor e.g., ID Number 

DebtorIdentification 

subTag 

AN 

R 

12 

The maximum amount that the payor is agreeing to in the smallest unit of the currency specified (eg in cents) 

Parameter 

Node Type 

Data Type 

Min Length 

Max Length 

Description 

CustomerReferenceIdentifier 

Tag 

AN 

8 

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

Type 

Private (P) or Business (B). Max Length = 1. Data Type = A 

Odometer reading 

Odometer reading. Max Length = 7. Data Type = N 

Fleet  LineItem  Parameters 

Quantity 

Subtag 

N 

0 

8 

he 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 

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. 

FLEET OIL 

Oil 

FLEET SERVICE 

Service 

FLEET TYRES 

Tyres 

FLEET ACCIDENTS 

Accidents 

FLEET ACCESSORIES 

Accessories 

FLEET BRAKES 

Brakes 

FLEET EXHAUSTS 

Exhausts 

FLEET SHOCK ABSORBERS 

Shock absorbers 

FLEET BATTERIES 

Batteries 

FLEET GLASS 

Glass 

FLEET TRUCK STOP 

Truck Stop 

FLEET FORECOURT SHOP 

Forecourt Shop 

FLEET HOTEL EXPENSES 

Hotel Expenses 

FLEET TOLL GATE 

Toll Gate 

FLEET MISCELLANEOUS 

Miscellaneous 

FLEET PREMIUM 

Premium Fuel 

FLEET REGULAR 

Regular Fuel 

FLEET SASOL 

Sasol Fuel 

FLEET DIESEL 

Diesel Fuel 

FLEET UNLEADED SUPER 

Unleaded Super Fuel 

FLEET UNLEADED PREMIUM 

Unleaded Premium Fuel 

FLEET AVIATION 

Aviation Fuel