Order
This is a JSON object with the following fields:
Field | Type | Required | Description | API Version |
---|---|---|---|---|
id | String(100) | yes | The unique ID for the order at merchant side | >= 002.70 |
type | String(2) | yes | Identifies the type of transaction being authenticated. The values are derived from ISO 8583. Possible values | >= 002.70 |
shippingType | String(2) | no | Indicates shipping method chosen for the transaction. Possible values | >= 002.70 |
deliveryDelay | String(2) | no | Indicates the merchandise delivery timeframe. Possible values | >= 002.70 |
deliveryEmail | String(100) | no | For electronic delivery, the email address to which the merchandise was delivered. | >= 002.70 |
reorder | Boolean | no | Indicates whether the cardholder is reordering previously purchased merchandise. | >= 002.70 |
preOrder | Boolean | no | Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. | >= 002.70 |
preOrderDate | String(8) | no | For a pre-ordered purchase, the expected date that the merchandise will be available. Date format must be YYYYMMDD. | >= 002.70 |
prepaidAmount | Integer(10) | no | For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in cents | >= 002.70 |
prepaidCurrency | String(3) | no | For prepaid or gift card purchase, the currency code of the card as defined in ISO-4217 | >= 002.70 |
prepaidCount | Integer(2) | no | For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. | >= 002.70 |
shopperLoyaltyProgram | String(50) | no | Customer Loyalty Program name | >= 002.70 |
totalWithoutShipping | Integer(32bits) | no | The payment amount in cents, without shipping fee | >= 002.70 |
shippingPrice | Integer(32bits) | no | The shipping amount in cents (for 1€ => 100) | >= 002.70 |
discount | Integer(32bits) | no | The discount amount in cents (for 1€ => 100) | >= 002.70 |
description | String(500) | no | Short description of the product purchased by the customer | >= 002.70 |
cartContent | Array of objects | no | Product or service bought - see details here | >= 002.70 |
affiliateID | String(16) | no | Numeric string for the identifier of the affiliate | >= 002.70 |
campaignName | String(128) | no | Name of the affiliation campaign | >= 002.70 |
merchantIdentifier | String(128) | no | Identifier from the merchant side. Can be used to do grouping later on. | >= 002.72 |
recurrence | Object | no | See Recurrence Object | >= 002.70 |