* *The File Transfer component of Enterprise facilitates the upload/download files to and from the iVeri Gateway. There may be files available for upload/download within Enterprise APIs that are not available via the BackOffice. Similarly, there may be files available for upload/download within BackOffice that are not available via the Enterprise APIs.
POS Parameters *
*
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
Web Service implementation *
**
All methods provided by the web service return a V_XML formatted response. The GetPinBlock method is the only exception. For card present transactions, the GetPinBlock method will return a PINBlock data structure.
The V_XML request and response format is defined by the V_XML.xsd schema, which can be downloaded from https://portal.nedsecure.co.za/schemas/v_xml/7.0/v_xml.xsd Client code must check the respective Result fields to determine if the web service method was successful or not. (Result fields are defined by the V_XML specification) For a client to call the execute method the client certificate ID must be provided with the HTTP Request
* Terminology *
*
This document uses certain iVeri specific terminology which can be referenced in Parameter Description
File Transfer Parameters *
**
Transaction Commands *
**
The following
transaction types encompasses the payment mechanism which the iVeri Gateway
supports and may cause the transfer of funds from cardholder to merchant or
vise-versa.
*File Transfer Parameter Description*
*
* Parameter *
* Description
*
* Gateway *
The name of the gateway connecting
to. If not explicitly set, the default gateway is used.
CertificateID
The iVeri CertificateID installed on
the server communicating with the iVeri Gateway
UserGroup
The UserGroup used to login to the
BackOffice website. Usually, the same as the BillingDetailsID
UserName
A Username created under the
specified UserGroup
Password
The BackOffice password of the
specified user
Command
The command identifying what should
be done by the iVeri Gateway.
TransactionHistory
Download
Recon
Download
Batch
Upload/Download
DiVert
Upload/Download
BINManagement
Download
BINLookup
Download
HotCard
Download
BlackCard
Download
Inventory
Download
ApplicationID
Identification
of the merchant prof
Refund/Credit *
**
The possible transaction sequence flow with an initial Credit is the following:
ForeignExchange Parameters *
*
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
* 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 *