KeyFormatConditionDescription
1

deliveryEmail

string

O

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

2

deliveryTimeframe

string

O

Indicates the merchandise delivery timeframe.

3

giftCardAmount

integer

O

For prepaid or gift card purchase, the purchase amount total of prepaid or gift cards in smallest currency unit.

4

giftCardCount

integer

O

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

5

giftCardCurr

string

O

For prepaid or gift card purchase, ISO 4217 three-digits numeric currency code of the gift card, e.g. 978.

6

preOrderDate

string

O

For a pre-ordered purchase, the expected date that the merchandise will be available (YYYY-MM-DD).

7

preOrderPurchaseIndicator

boolean

O

Indicates whether customer is placing an order for merchandise with a future availability or release date.

8

reorderItemsIndicator

boolean

O

Indicates whether the customer is reordering previously purchased merchandise.

9

shippingAddressIndicator

string

O

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

Schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://paymentpage.axepta.bnpparibas/schemas/merchantRisk.json",
    "title": "merchantRisk",
    "description": "Merchant Risk Information",
    "type": "object",
    "properties": {
        "deliveryEmail": {
            "type": "string",
            "maxLength": 50,
            "format": "idn-email",
            "description": "For Electronic delivery, the email address to which the merchandise was delivered."
        },
        "deliveryTimeframe": {
            "type": "string",
            "enum": ["electronicDelivery", "sameDayDelivery", "nextDayDelivery", "twoOrMoreDaysDelivery"]
        },
        "giftCardAmount": {
            "type": "integer",
            "maximum": 999999999999
        },
        "giftCardCount": {
            "type": "integer",
            "maximum": 99,
            "description": "Number of prepaid or gift cards used for this purchase."
        },
        "giftCardCurr": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "description": "ISO 4217 three-digits numeric currency code of the gift card, e.g. 978."
        },
        "preOrderDate": {
            "type": "string",
            "format": "full-date",
            "description": "The expected date that the merchandise will be available in format YYYY-MM-DD."
        },
        "preOrderPurchaseIndicator": {
            "type": "boolean",
            "description": "Indicates whether customer is placing an order for merchandise with a future availability or release date."
        },
        "reorderItemsIndicator": {
            "type": "boolean",
            "description": "Indicates whether the customer is reordering previously purchased merchandise."
        },
        "shippingAddressIndicator": {
            "type": "string",
            "enum": [
                "shipToBillingAddress",
                "shipToVerifiedAddress",
                "shipToNewAddress",
                "shipToStore",
                "digitalGoods",
                "noShipment",
                "other"
            ],
            "description": "Indicates shipping method chosen for the transaction. If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all digital goods, use the Shipping Indicator code that describes the most expensive item."
        }  
    },
    "additionalProperties": false
}

Sample

{
    "deliveryEmail": "joe.bloggs@acme.com",
    "deliveryTimeframe": "twoOrMoreDaysDelivery",
    "giftCardAmount": 5000,
    "giftCardCount": 2,
    "giftCardCurr": "978",
    "preOrderDate": "2020-03-15",
    "preOrderPurchaseIndicator": true,
    "reorderItemsIndicator": true,
    "shippingAddressIndicator": "shipToStore"
}
  • No labels