Parameter Description | iVeri Payment Technologies

Core Parameters

Parameter	Description
ApplicationID	Identification of the merchant’s configuration within the iVeri Gateway
CertificateID	The iVeri CertificateID installed on the server communicating with the iVeri Gateway
CertificatePath	Valid Path to directory where the KeyStoreFile or CertificateFile exists on the filesystem
CertificateFile	Existing certificate file
CertificatePassword	Password of the certificate
Gateway	The name of the gateway connecting to. If not explicitly set, the default gateway is used.
RequestID	A unique identifier generated by the iVeri Gateway for this request
Mode	The mode of the corresponding ApplicationID.
	Test\|Live

GetDevicePINKey	Get DevicePINKey (use Category='Security')
Ping	Ping (use Category='System')

Category	use if Command = 'Debit' or 'Credit' or 'Authorisation' or 'AuthorisationReversal' or 'Void'
	Transaction: use if Command = 'Debit' or 'Credit' or 'Authorisation' or 'AuthorisationReversal' or 'Void'
	System: use if Command = 'Ping'
	Enquiry: use if Command = 'Balance', 'PAN' or 'PANToken' or '‘AuthenticatedCollection' or ‘RequestForDebit’OR ‘AccountValidation’
	Security: use if Command = 'GetDevicePINKey'
Command	The command specifying what should be done by the iVeri Gateway
	Authorisation: (use Category='Transaction')
	AuthorisationReversal: (use Category='Transaction')
	Credit: (use Category='Transaction')
	Debit: (use Category='Transaction')
	Void: (use Category='Transaction')
	Balance Enquiry: (use Category='Enquiry')
	PAN: (use Category='Enquiry')
	PANToken: (use Category='Enquiry')
	AuthenticatedCollection:(use Category='Enquiry')
	AccountValidation: (use Category = ‘Enquiry’)
	RequestForDebit:(use Category = ‘Enquiry’)
	MasterPassQuickResponseCode:(use Category = ‘Enquiry’)
	DynamicCurrencyConversion: (use Category = ‘Enquiry’)

Common Parameters

Parameter	Description
Acquirer	The Acquiring system to which this transaction was routed by iVeri
	NBPostilion NB Zimbabwe
	NBPostilionUSD NB Zimbabwe
	CBZPostilion CBZ Zimbabwe
	CSCFIS CSC Lebanon
	NBPostilion iVeri SouthAfrica
	ICPSPwC CIM Mauritius
	OWWay4 IM Kenya
	NBPostilion NB Namibia
AcquirerDate	The date that the Acquirer allocated to this transaction
	YYYYMMDD
	YearMonthDay
AcquirerReference	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).
CCCCC: TTTTTTTT	CycleNumber: RRN8 (for Nedbank providers)
yyyyMMdd:tttttttt	CycleEndDate: RRN8 (for the TMS provider)
yyyyMMdd:ydddhhtttttt	CycleEndDate:RRN (for providers in general)
AcquirerTime	The time that the Acquirer allocated to this transaction
Amount	The total value of the transaction in the smallest unit of the currency specified (eg in cents)
AuthorisationCode	The Authorisation Code issued by the Issuer to the Merchant either telephonically or electronically
BudgetPeriod	The number of months over which the cardholder would like to pay the transaction off.
CardSecurityCode	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.
Currency	The ISO 4217 currency code of the value of the transaction. e.g., USD or ZAR or GBP
DisplayAmount	The Amount returned in a currency aware printable format
ExpiryDate	The last month of the validity period of the card
	MMYY
	MonthYear
CardholderName	The name of the cardholder as embossed on the card.
CardholderEmail	The email address of the cardholder
OrderDescription	A brief description of the purchase made by the cardholder
AllowBudgetPeriod	When this is true a ‘BudgetPeriod’ input field will be present on the CardDetails capture form.
RequestExpiryDate	The date after which the debit request will expire
CreateTransactionUrl	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	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	The merchant name associated with the ApplicationID
MerchantAddress	The merchant address associated with the ApplicationID
MerchantCity	The merchant city associated with the ApplicationID
MerchantCountryCode	The merchant country code associated with the ApplicationID
MerchantCountry	The merchant country name associated with the ApplicationID
MerchantReference	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	A merchant generated identifier of a previous transaction used in a Tokenized PAN transaction
MerchantTrace	Unique merchant identification for the request
MerchantUSN	The merchant USN associated with the ApplicationID
OriginalMerchantTrace	A reference to the original MerchantTrace previously sent to the iVeri Gateway
OriginalRequestID	The RequestID that was returned as part of the original transaction
PAN	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	The mechanism by which the PAN was determined from the card. The value is a comma separated list of the following:
PurchaseDate	The date on which the purchase was made. Defaults to current Date
PurchaseTime	The time at which the purchase was made. Defaults to current Time
ReconReference	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	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	Identifier optionally allocated by the merchant which is intended to group transactions together for reporting purposes in reconciliation statements.
Track2	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.
TransactionIndex	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.
MobileMoneyID	An additional transaction identifier returned for a PANFormat “MSISDN” transaction. This tag should be passed to the Gateway along with OriginalRequestID or OriginalMerchantTrace when the transaction needs to be Voided.
MSISDN	A mobile number required by PANFormat “MSISDN” transactions
VisaCheckoutCallID	Visa Checkout transaction ID associated with a payment request.
MasterPassTransactionID	This is the MasterPass system transaction reference
ForeignAmount	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	When doing a transaction in a foreign currency we need to specify the foreign currency here
	Mandatory when doing transaction in foreign currency
PANMode
ForeignExchangeID	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	An enumeration specifying how to obtain the PAN details
CardHolderPresence	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	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

3DSecure Parameters

Parameter	Node Type	Data Type	Max Length	Description
ElectronicCommerceIndicator	tag	A		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	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	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		The RequestID that was returned as part of the Enrollment Check that will be used to retrieve data for the Authentication Validation
ThreeDSecure_VEResEnrolled	Tag	A	1	Indicator that shows whether the cardholder is participating in 3DS.
ThreeDSecure_ProtocolVersion	Tag			Indicates the version of 3D secure used
ThreeDSecure_DSTransID	Tag			Directory Server Transaction ID returned for the transaction

Result Parameters

Parameter	Node Type	Data Type	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

Masterpass Parameters

Parameter	Description
MasterPassAction	Function for initiating MasterPass
MasterPassMerchantID	The merchant’s card acceptor ID
MasterPassShortDescription
MasterPassCodeExpiryDate	The expiry date of the QR code
MasterPassMerchantName	The merchant’s name
MasterPassCode
MasterPassTransactionID

Dynamic Currency Conversion

Parameter	Node Type	Data Type	Min Length	Max Length	Description
ForeignCurrency	Subtag	A	3	3	The ISO 4217 currency code of the value of the transaction. e.g. USD or ZAR or GBP
ForeignAmount	subTag	N	0	11	The total value of the transaction in the smallest unit of the currency specified (eg in cents)
ForeignExchangeID	Tag	AN			Contains a collection of ForeignExchangeItems

Airline Data

Parameter	Node Type	Data Type	Max Length	Description
PassengerName	subTag	AN	60	Passenger's first name.
PrimaryTicketNumber	subTag	AN	60	The ticket numbers.
FirstDepartureLocationCode	subTag	AN	32	Code for departure airport location, eg. JNB for Johannesburg
FirstArrivalLocationCode	subTag	AN	32	Code for destination airport location, eg. JNB for Johannesburg
OfficeIATANumber	subTag	AN	32	The office IATA number
OrderNumber	subTag	AN		The order number
PlaceOfIssue	subTag	AN		The ticket office location
DepartureDate	subTag	AN		Date of departure in yyyymmdd format

Note: The CompleteRoute, DepartureTime and JourneyType will only be used when doing CyberSource Advanced Fraud Screening.

UPOP SecurePlus Parameters

Parameter	Node Type	Data Type	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	Related Transaction Type. One of:               - Purchase               - Pre-authorization               The corresponding UnionPay protocol values are:               - 01: Purchase               - 02: Pre-authorization
UPOP_RequestID	Tag	Guid		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

CyberSource Parameters

Parameter	Node Type	Data Type	Max Length	Description
DeliveryMethod	subTag	0	255	Physical or Virtual
DeviceFingerprintID	SubTag	AN	88	Session ID for the fingerprint.
BillTo_FirstName	SubTag	AN	60	First name of cardholder
BillTo_LastName	SubTag	AN	60	Last name of cardholder
BillTo_Street	subTag	AN	60	Street address of cardholder
BillTo_City	subTag	AN	60	Billing city for cardholder
BillTo_State	subTag	AN	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	2	Billing country for cardholder. Use the two-character country codes.
BillTo_PostalCode	subTag	AN	10	Postal code of the billing address. Required only if the BillTo_Country field is US or CA
BillTo_Email	subTag	AN	100	Email address of the cardholder
BillTo_IPAddress	subTag	AN	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

POS Parameters

Parameter	Node Type	Data Type	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	Master/Session encryption specific: The device PIN Key encrypted under the device master key i.e. DMK(DPK)
MACDevicePINKey	Tag	Hex	8	Master/Session encryption specific: The MAC of the device PIN Key i.e. MAC(DPK)
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		the current batch id of the device (terminal)
PINBlock	Tag	Hex	16	The cardholders PIN encrypted using the current device pin key
KeySerialNumber	Tag	Hex	20	DUKPT encryption specific: Mandatory input parameter needed in decryption of a DUKPT PINBlock.
Track2KeySerialNumber	Tag	Hex	20	DUKPT Track2 encryption specific: Mandatory input parameter needed in decryption of a DUKPT Track2.
PANKeySerialNumber	Tag	Hex	20	UKPT PAN encryption specific: Mandatory input parameter needed in decryption of a DUKPT PAN.

EMV Parameters

Parameter	Node Type	Data Type	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

Procurement Parameters

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.

Procurement LineItems Parameters

Parameter	Node Type	Data Type	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	The ISO code for the country of residence of the Merchant. e.g., ZA, US, GB
DestinationZIPCode	Tag	AN	10	The Customers Destination ZIP code
NationalTax	Tag	N	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	1	Indicates whether VAT is applicable to this transaction. 0 NationalTax is NOT included, 1 NationalTax is included
OrderDate	Tag	A	6	The date that the order was placed. This is not necessarily the same as the PuchaseDate. Defaults to current Date
PurchaseIdentifier	Tag	AN	25	Optional description allocated by the Merchant to be displayed on the Merchants statement.  Defaults to MerchantReference.
ShipFromZIPCode	Tag	AN	10	The ZIP code of the Merchant (Shipping source ZIP code)
ShippingAmount	Tag	N	12	The amount charged to the customer for shipping charges in the currency's smallest denomination.
ShippingTaxRate	Tag		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	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	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.

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

Authenticated CollectionData Parameters

Parameter	Node Type	Data Type	Required/Optinal	Description
AccountNumber	subTag	AN	R	The account number that the payor is agreeing to allow the payee debit.
DebtorIdentification	SubTag	AN	R	Some data to identify the payor e.g., ID Number
DebtorIdentification	subTag	AN	R	The maximum amount that the payor is agreeing to in the smallest unit of the currency specified (eg in cents)

Fleet Parameters

Parameter

Node Type

Data Type

Min-Max Length

Description

CustomerReferenceIdentifier

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

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

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

Fleet Line-Item Parameters

Parameter	Node Type	Data Type	Max Length	Description
Quantity	Subtag	N	8	The total number of line item units
QuantityDecimalPlaces	subtag	N	4	The number of implied decimals in the Quantity
UnitCost	subtag	N	10	The cost of a line item unit in the currency's smallest denomination
ProductCode	subTag	AN	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