The Divert Batch Upload Data Elements

Tag Name

Length

Data Type

Format

Description

Amount

<=12

Numeric

The sum of the Amount sub-element values of all the <DivertItem> sub-elements

Count

<=6

Number

The number of <DivertItem> sub-elements

Tag Name

Length

Data Type

Format

Description

Date

8

Numeric

YYYYMMDD

The date when the batch was created (in which case the batch will be processed on the upload date) or a future date on which the batch should be processed (a past or future date cannot be more than 1 calendar month from the upload date)

Filename

<=64

Text

The Filename by which the Divert batch can be identified (must be unique for all Divert batches uploaded for an ApplicationID)

CreateTransactionUrl

Boolean

True|False

Used to generate the URL to which a payment can be made by the cardholder. When this value is set to ‘true’ a ‘TransactionUrl’ will be returned to the merchant, the merchant can then distribute the payment requests with this URL using their preferred comms. If set to ‘false’ a debit request email will be sent by the gateway on behalf of the merchant to the ‘CardholderEmail’

DivertItem

XML element

An element for each transaction in the Divert Batch, this can occur multiple times within a <Divert> 

Tag Name

Length

Data Type

Format

Description

Application ID

38

GUID

{00000000-0000-0000-0000-  000000000000}

The ApplicationID allocated generated by the gateway during merchant capture (the same ApplicationID must be used for all DivertItem elements under a Divert element)

Mode

4

Text

Test|Live

The mode of an ApplicationID

Command

<=64

Text

Debit|Authorisation|Credit|

The Transaction Type to be used

Tag Name

Length

Data Type

Format

Description

Amount

<=12

Numeric

The transaction value in cents ( no decimal point)

Currency

3

Alpha

The iSO currency code in which the transaction will be processed in ie. ZAR or USD

OrderDescription

<=255

Text

A description of the Divert Batch

MerchantReference

<=64

Unique merchant reference for this transaction. Must be unique for each DivertItem with Divert uploaded for an Application ID(normally  this an Invoice Number)

AllowBudgetPeriod

Boolean

True|False

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

CardholderName

<=50

CardholderEmail

<=128

String

The cardholder email address which the merchant will send payment request to

RequestExpiryDate

8

Numeric

YYYYMMDD

A future date which can be specified by the merchant on the validity period of the Divert payment request. If the date elapses and the request has not been processed by the cardholder the request will expire.