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- Sale/Purchase

 

M

Mandatory

O

Optional

C

Conditional

blank

not relevant

 

Context

Parameter

Debit with PAN

Debit with TransactionIndex

Void

Credit with PAN

Credit with TransactionIndex

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

 

 M

 M

Common

CardSecurityCode

O

O


O

O

Common

PAN

M

M


M


Common

Currency

 M

 M

 

 M

 M

Common

ExpiryDate

 M

 M

 

 M

Common

MerchantReference

 M

 M

 

 M

 M

Common

OriginalMerchantReference

 

 

 M

 

 

Common

MerchantTrace

 O

 O

 

 O

 O

Common

OriginalRequestID

 

 

 M

 

 

Common

PANFormat

 

 M

 

 

 M

Common

TransactionIndex

 

 M

 

 

 M

 Common

 CardHolderPresence

 C

 C

 

 

 

Common

PaymentGatewayID

C

C

C

C

Common

WalletProvider

C

C


C

C

Common

TokenCrytogram

C

C


C

C

Common

ForeignRetailIndicator

C

C


C

C

Common

AuthorisationCode

O

O


O

O

Common

BudgetPeriod

O

O


O

O

Common

PANMode






Common

Terminal

O

O


O

O

Common

VisaCheckoutCallID

C

C


C

C

Common

PurchaseDate

O

O


O

O

Common

PurchaseTime

O

O


O

O

Common

StartDate

O

O


O

O

Common

MSISDN






Common

MobileMoney






Common

OrderDescription

O

O


O

O

ThreeDsecure

ElectronicCommerceIndicator

C

C

 

 

 

ThreeDsecure

CardHolderAuthenticationData

C

C

 

 

 

ThreeDsecure

CardHolderAuthenticationID

C

C

 

 

 

ThreeDsecure

ThreeDSecure_DSTransID

C

C

 

 

 

ThreeDsecure

ThreeDSecure_ProtocolVersion

C

C

 

 

 

ThreeDsecure

ThreeDSecure_RequestID

O

O

 

 

 

ThreeDsecure

ThreeDSecure_AuthenticationType

O

O

 

 

 

ThreeDsecure

ThreeDSecure_VEResEnrolled

O

O

 

 

 



QR Code – MasterPass Parameters

 

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

 

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

 

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

 

 

 

 

 


Output Parameters

Point 2.

Point 3.

Point 4.