File Transfer - Automating File Transfer process

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.

 

File Transfer Data Types

The File Transfer parameters have the following data types:

Data Type

Description

Guid

Global 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})

N

Numeric (Positive integer)

String

Free format string containing, alpha numeric, special, and adding (printable ASCII)

 

 


The Node Type column corresponds to how the FileTransfer class should be used for the parameter:

Node Type

Set input parameter value

property

Use method or property of FileTransfer corresponding to the parameter

tag

fileTransfer.setTag(..)

File Transfer Parameters

The following is set of parameters available.

 

Parameter

Node Type

Data Type

Minimum Length

Maximum Length

Gateway

property

A

 

10

CertificateID

property

Guid

38

38

UserGroup

property

N

 

10

UserName

property

String

 

16

Password

property

String

 

32

Command

property

A

 

50

ApplicationID

Property

Guid

38

50

Mode

property

A

4

4

FileName

tag

String

0

50

FileFormat

tag

String

0

10

StartDateTime

tag

String

0

20

EndDateTime

tag

String

0

20

Acquirer

tag

A

3

32

AcquirerCycle

tag

N

5

8

MerchantUsn

tag

N

5

20

 

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 profile performing the file transfer

Mode

The mode of the corresponding ApplicationID

FileName

The identifying file name of the original batch / divert file uploaded

FileFormat

The format of the batch file to download

Fixed

Default

XML

 

 

 

StartDateTime

The starting datetime from which reconciliation information are required

 

YYYY-MM-DD HH:MM: SS

YearMonthDay HourMinuteSecond

EndDateTime

The ending datetime to which reconciliation information are required

 

YYYY-MM-DD HH:MM: SS

 

YearMonthDay HourMinuteSecond

Acquirer

The acquirer that settled the transactions

NBPostillionNBSouthAfrica

 

IMNaradaIMKenya

 

CBZPostilionCBZZimbabwe

 

ICPSPwCCIMMauritius

 

NBPostilioniVeriSouthAfrica

 

EMPTranzWareCBZZimbabwe

 

CSCFISAIBAfghanistan

 

CSCFISCBZZimbabwe

 

NBPostilionNBNamibia

 

 

 

AcquirerCycle

The cycle from which reconciliation information are required

MerchantUsn

Acquirer identification for a merchant account

File Transfer Commands

 

Uploads Commands

Command

Description

Batch

 

Divert

 

Download Commands

TransactionHistory

with a date time interval

Recon

with a cycle interval for an acquirer

Batch

 

Divert

 

HotCard

 

BinLookup

 

BinManangement

 

BlackCard

 

AcquireRecon

 

Inventory

currently only available to Nedbank merchants accepting Fleet cards)

 

File Transfer Parameters per action


The input parameters that are relevant to each action are shown in the following table using the following key

M

Mandatory

O

Optional

Blank

Not relevant


Parameter

Batch Upload

Batch Download

Recon Download

TransactionHistory

DiVert Upload

DiVert Download

HotCard Download

BINLookup Download

BINManagement Download

BlackCard Download

AcquirerRecon Download

Inventory Download

DiVert Upload

O

O

O

O

O

O

O

O

O

O

O

O

CertificateID

M

M

M

M

M

M

M

M

M

M

M

M

UserGroup

M

M

M

M

M

M

M

M

M

M

M

M

UserName

M

M

M

M

M

M

M

M

M

M

M

M

Password

M

M

M

M

M

M

M

M

M

M

M

M

Command

M

M

M

M

M

M

M

M

M

M

M

M

ApplicationID

 

 

O

M

 

O

 

 

M

M

 

 

Mode

 

O

M

M

 

O

 

 

M

M

 

 

FileName

 

O

 

 

O

 

 

 

 

 

O

 

FileFormat

 

O

 

 

 

 

 

 

 

 

 

 

StartDateTime

 

 

 

M

 

 

 

 

 

 

 

 

EndDateTime

 

 

 

M

 

 

 

 

 

 

 

 

Acquirer

 

 

 

M

 

 

 

 

 

 

M

 

AcquirerCycle

 

 

 

M

 

 

 

 

 

 

 

 

MerchantUsn

 

 

 

M