Parameter Description & Action

This section describes the various gateway parameters available. This is followed by a table of what input and output parameters are relevant for each action. Parameters are shown grouped according to their usage.

Data Types

The following key table is used for data types:

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

Ecommerce, Card Not Present

M	Mandatory
O	Optional
C	Conditional
blank	not relevant

Sale/Purchase

These are the possible input parameters that can be set for an “Sale/Purchase” and subsequent actions

Contex	Parameter	Debit with PAN	Debit with TransactionIndex	Void

Core	ApplicationID	M	M	M
Core	Category	M	M	M
Core	CertificateID	M	M	M
Core	Command	M	M	M
Core	Gateway	O	O	O
Core	Mode	M	M	M
Common	Amount	M	M
Common	CardSecurityCode	O	O
Common	PAN	M	M
Common	Currency	M	M
Common	ExpiryDate	M	M
Common	AuthorisationCode	O	O
Common	BudgetPeriod	O	O
Common	TransactionIndex		M
Common	PANFormat		M
Common	PANMode
Common	CardHolderPresence		C
Common	CardholderName	O	O
Common	MerchantReference	M	M
Common	MerchantTrace	O	O	O
Common	OriginalMerchantTrace			M
Common	OriginalMerchantReference
Common	OriginalRequestID			M
Common	PurchaseDate	O	O
Common	PurchaseTime	O	O
Common	StartDate
Common	Terminal
Common	MSISDN
Common	VisaCheckoutCallID	C	C
Common	MobileMoney
Common	CardholderEmail
Common	AllowBudgetPeriod	O	O
Common	ForeignRetailIndicator	C	C
Common	Cryptogram	C	C
ThreeDSecure	ThreeDSecure_ProtocolVersion"
ThreeDSecure	CardHolderAuthenticationID
ThreeDSecure	CardHolderAuthenticationData
ThreeDSecure	ElectronicCommerceIndicator"
ThreeDSecure	ThreeDSecure_DSTransID
ThreeDSecure	ThreeDSecure_AuthenticationType
ThreeDSecure	ThreeDSecure_VEResEnrolled

Output Parameters that may be returned:

Y	Relevant (maybe populated)
C	Returned if supported by Acquirer
Blank	Not relevant

Context	Parameter	Debit with PAN	Debit with TransactionIndex	Void
Core	Direction	Y	Y
Core	ApplicationID	Y	Y	Y
Core	Category	Y	Y	Y
Core	CertificateID	Y	Y	Y
Core	RequestID	Y	Y	Y
Core	Command	Y	Y	Y
Core	Mode	Y	Y	Y
Common	Amount	Y	Y
Common	Acquirer	Y	Y
Common	AcquirerTrace	Y	Y
Common	AcquirerReference	Y	Y
Common	AcquirerDate	Y	Y
Common	AcquirerTime	Y	Y
Common	DisplayAmount	Y	Y
Common	Bin	Y	Y
Common	Association	Y	Y
Common	CardType	Y	Y
Common	Issuer	Y	Y
Common	Jurisdiction	Y	Y
Common	ElectronicCommerceIndicator	Y	Y
Common	PAN	Y	Y
Common	CCNumber	Y	Y
Common	Currency	Y	Y
Common	ExpiryDate	Y	Y
Common	AuthorisationCode	Y	Y
Common	BudgetPeriod
Common	TransactionIndex	Y	Y
Common	OriginalRequestID			Y
Common	PANMode	Y	Y
Common	CardHolderPresence	Y	Y
Common	CardholderName
Common	MerchantUSN	Y	Y
Common	MerchantName	Y	Y
Common	MerchantReference	Y	Y
Common	MerchantTrace	Y	Y
Common	Terminal	Y	Y
Common	MerchantAddress	Y	Y
Common	MerchantCity	Y	Y
Common	MerchantCountry	Y	Y
Common	MerchantCountryCode	Y	Y
Common	Gateway			Y
Common	DistributorName	Y	Y
Common	ReconReference	C	C
Common	Result	Y	Y	Y
Common	Status	Y	Y	Y
Common	Code	Y	Y	Y
Common	Description	Y	Y
Common	Source	Y	Y	Y
Common	AppServer	Y	Y	Y
Common	DBServer	Y	Y	Y
Common	AcquirerCode	Y	Y	Y
Common	AcquirerDescription	Y	Y	Y

Authorisation and Completion

These are the possible input parameters that can be set for an “Authorisation” and subsequent actions

Contex	Parameter	Authorisation with PAN	Authorisation with TransactionIndex	Follow-Debit (Completion)	Authorisation Reversal

Core	Direction	M	M	M	M
Core	ProductType	M	M	M	M
Core	ProductVersion	M	M	M	M
Core	Version	M	M	M	M
Core	ApplicationID	M	M	M	M
Core	Category	M	M	M	M
Core	CertificateID	M	M	M	M
Core	Command	M	M	M	M
Core	Mode	M	M	M	M
Common	Amount	M	M	M
Common	CardSecurityCode	O	O
Common	PAN	M	M
Common	Currency	M	M
Common	ExpiryDate	M	M
Common	AuthorisationCode	O	O
Common	BudgetPeriod	O	O
Common	TransactionIndex		M	M	M
Common	PANFormat		M
Common	PANMode
Common	CardHolderPresence		C
Common	CardholderName	O	O
Common	MerchantReference	M	M	O	O
Common	MerchantTrace	O	O	M	O
Common	OriginalMerchantTrace
Common	OriginalMerchantReference
Common	OriginalRequestID
Common	PurchaseDate	O	O
Common	PurchaseTime	O	O
Common	StartDate
Common	Terminal	O	O
Common	MSISDN
Common	VisaCheckoutCallID	C	C
Common	MobileMoney
Common	CardholderEmail
Common	AllowBudgetPeriod	O	O
Common	ForeignRetailIndicator	C	C
Common	Cryptogram	C	C
ThreeDSecure	ThreeDSecure_ProtocolVersion"	C	C
ThreeDSecure	CardHolderAuthenticationID	C	C
ThreeDSecure	CardHolderAuthenticationData	C	C
ThreeDSecure	ElectronicCommerceIndicator"	C	C
ThreeDSecure	ThreeDSecure_DSTransID	C	C
ThreeDSecure	ThreeDSecure_AuthenticationType	C	C
ThreeDSecure	ThreeDSecure_VEResEnrolled	C	C

Output Parameters that may be returned:

Y	Relevant (maybe populated)
C	Returned if supported by Acquirer
Blank	Not relevant

Contex	Parameter	Debit with PAN		Debit with TransactionIndex	Authorisastion Reversal
Core	Direction	Y	Y	Y
Core	ApplicationID	Y	Y	Y	Y
Core	Category	Y	Y	Y	Y
Core	CertificateID	Y	Y	Y	Y
Core	Command	Y	Y	Y	Y
Core	Mode	Y	Y	Y	Y
Common	Amount	Y	Y	Y	Y
Common	Acquirer rTrace	Y	Y	Y	Y
Common	AcquirerTrace	Y	Y	Y	Y
Common	AcquirerReference	Y	Y	Y	Y
Common	AcquirerDate	Y	Y	Y	Y
Common	AcquirerTime	Y	Y	Y	Y
Common	DisplayAmount	Y	Y	Y	Y
Common	Bin	Y	Y	Y	Y
Common	Association	Y	Y	Y	Y
Common	CardType	Y	Y	Y	Y
Common	Issuer	Y	Y	Y	Y
Common	Jurisdiction	Y	Y	Y	Y
Common	ElectronicCommerceIndicator	Y	Y	Y	Y
Common	PAN	Y	Y	Y	Y
Common	CCNumber	Y	Y	Y	Y
Common	Currency	Y	Y	Y	Y
Common	ExpiryDate	Y	Y	Y	Y
Common	AuthorisationCode	Y	Y	Y	Y
Common	BudgetPeriod
Common	TransactionIndex	Y	Y	Y
Common	OriginalRequestID
Common	PANMode	Y	Y	Y	Y
Common	CardHolderPresence	Y	Y	Y	Y
Common	CardholderName
Common	MerchantUSN	Y	Y	Y	Y
Common	MerchantName	Y	Y	Y	Y
Common	MerchantReference	Y	Y	Y	Y
Common	MerchantTrace	YY	Y	Y	Y
Common	Terminal	Y	Y	Y	Y
Common	MerchantAddress	Y	Y	Y	Y
Common	MerchantCity	Y	Y	Y	Y
Common	MerchantCountry	Y	Y	Y	Y
Common	MerchantCountryCode	Y	Y	Y	Y
Common	GatewaybutorName
Common	DistributorName	Y	Y	Y	Y
Common	ReconReference	C	C	C	C
Common	RequestID	Y	Y	Y	Y
Common	Result	Y	Y	Y	Y
Common	Status	Y	Y	Y	Y
Common	Code	Y	Y	Y	Y
Common	Description	Y	Y	Y	Y
Common	Source	Y	Y	Y	Y
Common	AppServer	Y	Y	Y	Y
Common	DBServer	Y	Y	Y	Y
Common	AcquirerCode	Y	Y	Y	Y
Common	AcquirerDescription	Y With PAN	Y	Y (Completion)	Y Reversal

Refund

These are the possible input parameters that can be set for an “Refund” and subsequent actions

Context	Parameter	Credit with PAN	Credit with TransactionIndex
Core	Direction	M	M
Core	ProductType	M	M
Core	ProductVersion	M	M
Core	Version	M	M
Core	ApplicationID	M	M
Core	Category	M	M
Core	CertificateID	M	M
Core	Command	M	M
Core	Mode	M	M
Core	Gateway
Common	Amount	M	M
Common	CardSecurityCode	O
Common	PAN	M	M
Common	Currency	M	M
Common	ExpiryDate	M	M
Common	AuthorisationCode
Common	BudgetPeriod
Common	TransactionIndex		M
Common	PANFormat		M
Common	PANMode
Common	CardHolderPresence
Common	CardholderName
Common	MerchantReference	M	M
Common	MerchantTrace	O	O
Common	OriginalMerchantTrace
Common	OriginalMerchantReference
Common	OriginalRequestID
Common	PurchaseDate
Common	PurchaseTime
Common	StartDate
Common	Terminal
Common	MSISDN
Common	VisaCheckoutCallID		C
Common	MobileMoney
Common	CardholderEmail
Common	AllowBudgetPeriod
Common	ForeignRetailIndicator	C	C
Common	Cryptogram
ThreeDSecure	ThreeDSecure_ProtocolVersion"
ThreeDSecure	CardHolderAuthenticationID
ThreeDSecure	CardHolderAuthenticationData
ThreeDSecure	ElectronicCommerceIndicator"
ThreeDSecure	ThreeDSecure_DSTransID
ThreeDSecure	ThreeDSecure_AuthenticationType
ThreeDSecure	ThreeDSecure_VEResEnrolled

Refund output parameters that may be returned:

Y	Relevant (maybe populated)
C	Returned if supported by Acquirer
Blank	Not relevant

Context	Parameter	Credit with PAN	Credit with TransactionIndex
Core	Direction	Y	Y
Core	ApplicationID	Y	Y
Core	Category	Y	Y
Core	CertificateID	Y	Y
Core	Command	Y	Y
Core	Mode	Y	Y
Core	Gateway	Y	Y
Core	RequestID	Y	Y
Common	Amount	Y	Y
Common	AcquirerTrace	Y	Y
Common	AcquirerReference	Y	Y
Common	AcquirerDate	Y	Y
Common	AcquirerTime	Y	Y
Common	DisplayAmount	Y	Y
Common	Bin	Y	Y
Common	Association	Y	Y
Common	CardType	Y	Y
Common	Issuer	Y	Y
Common	Jurisdiction	Y	Y
Common	ElectronicCommerceIndicator	Y	Y
Common	PAN	Y	Y
Common	CCNumber	Y	Y
Common	Currency	Y	Y
Common	ExpiryDate	Y	Y
Common	AuthorisationCode	Y	Y
Common	BudgetPeriod
Common	TransactionIndex	Y	Y
Common	OriginalRequestID
Common	PANMode	Y	Y
Common	CardHolderPresence	Y	Y
Common	CardholderName
Common	MerchantUSN	Y	Y
Common	MerchantName	Y	Y
Common	MerchantReference	Y	Y
Common	MerchantTrace	YY	Y
Common	Terminal	Y	Y
Common	MerchantAddress	Y	Y
Common	MerchantCity	Y	Y
Common	MerchantCountry	Y	Y
Common	MerchantCountryCode	Y	Y
Common	GatewaybutorName
Common	DistributorName	Y	Y
Common	ReconReference	C	C
Common	Result	Y	Y
Common	Status	Y	Y
Common	Code	Y	Y
Common	Description	Y	Y
Common	Source	Y	Y
Common	AppServer	Y	Y
Common	DBServer	Y	Y
Common	AcquirerCode	Y	Y
Common	AcquirerDescription	Y	Y

QR Code – MasterPass Parameters

M	Mandatory
O	Optional
C	Conditional
blank	not relevant

Context	Parameter	MasterPassQuickResponseCode	MasterPassPaymentNotification	Credit with TransactionIndex	Void
Core	ApplicationID	M	M	M	M
Core	Category	M	M	M	M
Core	CertificateID	M	M	M	M
Core	Gateway	O	O	O	O
Core	Command	M	M	M	M
Core	Mode	M	M	M	M
Common	Amount
Common	ExipiryDate
Common	Currency
Common	MerchantReference
MasterPass	MasterPassAction	M
MasterPass	MasterPassMerchantID	M
MasterPass	MasterPassShortDescription
MasterPass	MasterPassCodeExpiryDate
MasterPass	MasterPassMerchantName
MasterPass	MasterPassCode
MasterPasss	MasterPassTransactionID

Request Payment – Divert Parameters

M	Mandatory
O	Optional
C	Conditional
blank	not relevant

Context	Parameter	*RequestForDebit*	*RequestForAuthorisation*
Core	ApplicationID	M	M
Core	Category	M	M
Core	CertificateID	M	M
Core	Gateway	O	O
Core	Command	M	M
Core	Mode	M	M
Common	Amount	M	M
Common	Currency	M	M
Common	MerchantReference	M	M
Common	CardholderName	M	M
Common	CardholderEmail	C	C
Common	OrderDescription	O	O
Common	AllowBudgetPeriod	O	O
Common	RequestExpiryDate	O	O
Common	CreateTransactionUrl	O	O

Card Present Parameters- Sale/Purchase

M	Mandatory
O	Optional
C	Conditional
blank	not relevant

Context	Parameter	Debit with Track2	Debit with TransactionIndex	Credit with Track2	Credit with TransactionIndex	Void
Core	ApplicationID	M	M	M	M	M
Core	Category	M	M	M	M	M
Core	CertificateID	M	M	M	M	M
Core	Gateway	O	O	O	O	O
Core	Command	M	M	M	M	M
Core	Mode	M	M	M	M	M
Common	Amount	M	M
Common	ExipiryDate	M	M
Common	Currency	M	M
Common	MerchantReference	M	M
Common	MerchantTrace	O	O
Common	BudgetPeriod	O	O
Common	OriginalMerchantTrace
Common	Track2	M	C
Common	PANMode	M	C
Common	Terminal	M	C
Common	AccountType	M	C
POS	CashAmount	O	O
POS	DeviceFirmware	O	O
POS	DeviceFirmwareVersion	O	O
POS	DeviceMake
POS	DeviceSerialNumber
POS	DeviceCycle
POS	KeySerialNumber
POS	Track2KeySerialNumber
POS	PANKeySerialNumber
POS	PinBlock
POS	EMV_AuthorisationRequestCryptogram
POS	EMV_ApplicationIdentifier
POS	EMV_ApplicationInterchangeProfile
POS	EMV_CardSequenceNumber
POS	EMV_ApplicationTransactionCounter
POS	EMV_ApplicationVersion
POS	EMV_CardHolderVerificationMethodRe sult
POS	EMV_CryptogramInformationData
POS	EMV_IssuerApplicationData
POS	EMV_IssuerApplicationData
POS	EMV_TerminalCapabilities
POS	EMV_TerminalType
POS	EMV_TransactionType
POS	EMV_TerminalVerificationResult
POS	EMV_UnpredictableNumber
POS	EMV_TransactionStatusInformation