Transmitting order details
The merchant can indicate in their payment form if they wish to transfer the order details (order reference, description, shopping cart contents, etc.).
To trigger one or several actions depending on the contents of the buyer’s shopping cart, the shopping cart data must imperatively be transmitted in the payment request.
Field name | Description | Value |
---|---|---|
Hosted Payment Page : vads_order_id REST API : orderId | Order ID | E.g.: 2-XQ001 |
Hosted Payment Page : vads_order_info REST API : metadata.orderInfo1 | Complementary order details | E.g.: Door code 3125 |
Hosted Payment Page : vads_order_info2 REST API : metadata.orderInfo2 | Complementary order details | E.g.: No elevator |
Hosted Payment Page : vads_order_info3 REST API : metadata.orderInfo3 | Complementary order details | E.g.: Express |
Hosted Payment Page : vads_nb_products REST API: N/A | Number of items in the cart | E.g.: 2 |
Hosted Payment Page : vads_product_ext_idN REST API: N/A | Product barcode on the merchant website. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). | E.g.: 0123654789123654789 |
Hosted Payment Page : vads_product_labelN REST API : cartItemInfo.productLabel | Item name. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). | E.g.: 3-day stay with dates |
Hosted Payment Page : vads_product_amountN REST API : cartItemInfo.productLabel | Item amount expressed in the smallest currency unit. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). | E.g.: 32150 |
Hosted Payment Page : vads_product_typeN REST API : cartItemInfo.productType | Item type. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). See the table with values below. | E.g.: TRAVEL |
Hosted Payment Page : vads_product_refN REST API : cartItemInfo.productRef | Item reference. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). | E.g.: 1002127784 |
Hosted Payment Page : vads_product_qtyN REST API : cartItemInfo.productQty | Item quantity. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). | E.g.: 1 |
Item type (vads_product_type / productType)
Value | Description |
---|---|
FOOD_AND_GROCERY | Food and grocery |
AUTOMOTIVE | Cars / Moto |
ENTERTAINMENT | Entertainment / Culture |
HOME_AND_GARDEN | Home / Gardening |
HOME_APPLIANCE | Household appliances |
AUCTION_AND_GROUP_BUYING | Auctions / Group purchasing |
FLOWERS_AND_GIFTS | Flowers / Presents |
COMPUTER_AND_SOFTWARE | Computers / Software |
HEALTH_AND_BEAUTY | Health / Beauty |
SERVICE_FOR_INDIVIDUAL | Services for individuals |
SERVICE_FOR_BUSINESS | Services for companies |
SPORTS | Sports |
CLOTHING_AND_ACCESSORIES | Clothes / Accessories |
TRAVEL | Travel |
HOME_AUDIO_PHOTO_VIDEO | Audio / Photo / Video |
TELEPHONY | Telephony |