MerchantRiskIndicatorXML

On this page:

Overview

The Merchant Risk Indicator contains information about the cardholder's specific purchases. 

XML Tags

The MerchantRiskIndicatorXML tags and data validation rules are described in the following table. The XML tags should follow the order they are listed.

MerchantRiskIndicatorXML Field Description Table

Name

 Description

Mandatory

Valid Characters

Max Length

Allowed Values

merchantRiskIndicator

The root element for all other merchantRiskIndicator elements.

No

 

 

 

deliveryEmailAddress

For electronic delivery, indicates the email address to which the merchandise was delivered.

No

RFC532N

254

 

deliveryTimeframe

Indicates the merchandise delivery timeframe.

Valid values are:

  • 01 = Electronic Delivery

  • 02 = Same day shipping

  • 03 = Overnight shipping

  • 04 = Two-day or more shipping

No

Digits

2

  • 01

  • 02

  • 03

  • 04

giftCardAmount

For prepaid or gift card purchase, indicates the purchase amount total of prepaid or gift cards in major units

For example, GBP 123.45 is 123.

No

Digits

15

 

giftCardCount

For prepaid or gift card purchase, indicates the total count of individual prepaid or gift cards or codes purchased.

No

Digits

2

 

giftCardCurr

For prepaid or gift card purchase, indicates the currency code of the card as defined in ISO 4217.

For example, GBP or EUR.

No

ISO4217

3

 

preOrderDate

For a pre-ordered purchase, this is the expected date that the merchandise will be available.

No

Digits and hyphens

 

10

YYYY-MM-DD

preOrderPurchaseInd

Whether Cardholder is placing an order for merchandise available now, or on a future availability or release date.

  • 01 = Merchandise available

  • 02 = Future availability

No

Digits

2

  • 01

  • 02

reorderItemsInd

Whether this is a first-time purchase, or the cardholder is reordering previously purchased merchandise.

  • 01 = First time ordered

  • 02 = Reordered

No

Digits

2

 

shipIndicator

The shipping method chosen for the transaction.

Choose the Shipping Indicator code that most accurately describes the cardholder’s specific transaction and not their general business.

If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all are digital goods, use the Shipping Indicator code that describes the most expensive item.

  • 01 = Ship to cardholder’s billing address

  • 02 = Ship to another verified address on file with merchant

  • 03 = Ship to address that is different than the cardholder’s billing address

  • 04 = “Ship to Store” or pick-up at local store (Store address shall be populated in shipping address fields)

  • 05 = Digital goods, including online services, electronic gift cards, and redemption codes

  • 06 = Travel and event tickets, not shipped

  • 07 = Other (for example, Gaming, digital services not shipped, or e-media subscriptions)

No

Digits

2

  • 01

  • 02

  • 03

  • 04

  • 05

  • 06

  • 07