Common Parameters

 

Parameter 

Node Type 

Data Type 

Min Length 

Max Length 

Description 

Acquirer 

tag 

32 

The Acquiring system to which this transaction was routed by iVeri 

 

NBPostllionNBSA 

 

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 

tag 

 

64 

The date that the Acquirer allocated to this transaction 

YYYYMMDD 

YearMonthDay 

AcquirerReference 

tag 

 

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

 

CCCCC: TTTTTTTT 

CycleNumber: RRN8 (for Nedbank providers) 

yyyyMMdd:tttttttt 

CycleEndDate: RRN8 (for the TMS provider) 

yyyyMMdd:ydddhhtttttt 

CycleEndDate:RRN (for providers in general) 

 

 

AcquirerTime 

tag 

 

The time that the Acquirer allocated to this transaction 

HHMMSS 

HourMinuteSecond 

Amount 

tag 

12 

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

AuthorisationCode 

Tag 

AN 

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

BudgetPeriod 

Tag 

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

 

0 

Default 

3 

 

6 

 

9 

 

12 

 

18 

 

24 

 

36 

 

 

CardSecurityCode 

Tag 

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 

 

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 

The last month of the validity period of the card 

MMYY 

MonthYear 

 

MMYYYY 

MonthYear 

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 

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  

 

The merchant country code associated with the ApplicationID 

MerchantCountry 

Tag 

String 

 

50 

The merchant country name associated with the ApplicationID 

MerchantReference 

Tag 

String 

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 

64 

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

MerchantTrace 

Tag 

String  

64 

Unique merchant identification for the request 

MerchantUSN 

Tag 

String 

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 

128 

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

 

Name 

 

Direction 

Description 

Keyed  

Input/Output 

Card number was keyed 

 

Tokenized 

Output 

PANFormat 'TransactionIndex', 'OriginalMerchantReference' or 'MSISDN' (non-registration) was specified in the request 

 

Swiped 

Input/Output 

Card was swiped. This means that a Track2 must be specified in the request. 

 

Dipped 

Input/Output 

Card was processed while in the card reader slot of the device. This means that a Track2 must be specified in the request. 

Tapped 

Input/Output 

Card was processed by a contactless device. This means that a24 Track2 must be specified in the request. 

ConstructedTrack2 

Output 

For when a partial Track2 is received in the request usually accompanied by a PINBlock as one of the legs of a PANFormat “MSISDN” transaction. 

CVV 

Output 

The CardSecurityCode tag had a value in the request 

PIN 

Output 

The PINBlock tag had a value in the request 

PINCapable 

Input/Output 

No online PIN or EMV data sent to the gateway, but the device is capable to process PIN. 

EMV 

Output 

 
EMV data were specified in the request. 

 

EMVFallback 

Output 

No EMV data specified in the request, but the service code of the request Track2 indicate a chip card. 

EncryptedPAN 

Output 

The value of the PAN tag in the request specified encrypted data 

EncryptedTrack2 

Output 

The value of the Track2 tag in the request specified encrypted data 

PurchaseDate 

Tag 

 

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

 

MMDD 

 

MonthDay 

PurchaseTime 

Tag 

 

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

HHMM 

HourMinute 

ReconReference 

Tag 

N 

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 

 

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 

 

MMYY 

MonthYear 

MMYYYY 

MonthYear 

Terminal 

Tag 

N 

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. 

MobileMoneyID 

Tag 

N 

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 

Tag 

String 

 

 

A mobile number required by PANFormat “MSISDN” transactions 

VisaCheckoutCallID 

Tag 

String  

48 

Visa Checkout transaction ID associated with a payment request. 

MasterPassTransactionID 

Tag 

N 

 

 

This is the MasterPass system transaction reference 

ForeignAmount 

Tag 

String  

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 

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. 

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  

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: 

CardPresent 

Gets set in the output when a full Track2 was specified in the request. This value may also be set in the request when the card number was keyed on a POS device. 

 

 

 

 

 

CardNotPresent 

The physical plastic of the card was not present when the request was sent to the gateway. 

 

 

 

 

 

eCommerce 

Gets set in the output when one of the ElectronicCommerceIndicator values was specified in the request 

 

 

 

 

 

ThreeDSecure 

Encryption (SSL) used between CardHolder and Merchant. ThreeDSecure was successful 

 

 

 

 

 

ThreeDSecureAttempted 

Encryption (SSL) used between CardHolder and Merchant. ThreeDSecure was attempted unsuccessfuly 

 

 

 

 

 

SecureChannel 

Encryption (SSL) used between CardHolder and Merchant. ThreeDSecure not used 

 

 

 

 

 

ClearChannel 

No encryption used between CardHolder and Merchant 

 

 

 

 

 

MOTO 

Telephonic or mail order 

 

 

 

 

 

Recurring 

Transactions submitted by a merchant automatically