merchantRiskIndicator | Computop Documents

Data Elements

Key

Format

CND

Description

deliveryEmail

string

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

deliveryTimeframe

string

Indicates the merchandise delivery timeframe

giftCardAmount

integer

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

giftCardCount

integer

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

giftCardCurr

string

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

preOrderDate

string

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

preOrderPurchaseIndicator

boolean

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

reorderItemsIndicator

boolean

Indicates whether the customer is reordering previously purchased merchandise

shippingAddressIndicator

string

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

BASEURL= https://www.computop-paygate.com/schemas

1
{
2
    "$schema": "http://json-schema.org/draft-07/schema#",
3
    "$id": "BASEURL/merchantRisk.json",
4
    "title": "merchantRisk",
5
    "description": "Merchant Risk Information",
6
    "type": "object",
7
    "properties": {
8
        "deliveryEmail": {
9
            "type": "string",
10
            "maxLength": 254,
11
            "format": "idn-email",
12
            "description": "For Electronic delivery, the email address to which the merchandise was delivered."
13
        },
14
        "deliveryTimeframe": {
15
            "type": "string",
16
            "enum": ["electronicDelivery", "sameDayDelivery", "nextDayDelivery", "twoOrMoreDaysDelivery"]
17
        },
18
        "giftCardAmount": {
19
            "type": "integer",
20
            "maximum": 999999999999
21
        },
22
        "giftCardCount": {
23
            "type": "integer",
24
            "maximum": 99,
25
            "description": "Number of prepaid or gift cards used for this purchase."
26
        },
27
        "giftCardCurr": {
28
            "type": "string",
29
            "minLength": 3,
30
            "maxLength": 3,
31
            "description": "ISO 4217 three-digits numeric currency code of the gift card, e.g. 978."
32
        },
33
        "preOrderDate": {
34
            "type": "string",
35
            "format": "full-date",
36
            "description": "The expected date that the merchandise will be available in format YYYY-MM-DD."
37
        },
38
        "preOrderPurchaseIndicator": {
39
            "type": "boolean",
40
            "description": "Indicates whether customer is placing an order for merchandise with a future availability or release date."
41
        },
42
        "reorderItemsIndicator": {
43
            "type": "boolean",
44
            "description": "Indicates whether the customer is reordering previously purchased merchandise."
45
        },
46
        "shippingAddressIndicator": {
47
            "type": "string",
48
            "enum": [
49
                "shipToBillingAddress",
50
                "shipToVerifiedAddress",
51
                "shipToNewAddress",
52
                "shipToStore",
53
                "digitalGoods",
54
                "noShipment",
55
                "other"
56
            ],
57
            "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."
58
        }  
59
    },
60
    "additionalProperties": false
61
}

Sample

1
{
2
    "deliveryEmail": "joe.bloggs@acme.com",
3
    "deliveryTimeframe": "twoOrMoreDaysDelivery",
4
    "giftCardAmount": 5000,
5
    "giftCardCount": 2,
6
    "giftCardCurr": "978",
7
    "preOrderDate": "2020-03-15",
8
    "preOrderPurchaseIndicator": true,
9
    "reorderItemsIndicator": true,
10
    "shippingAddressIndicator": "shipToStore"
11
}