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.).

Use optional fields according to your requirements.

Field name	Description	Format	Value
vads_order_id	Order ID Can contain uppercase or lowercase characters, numbers or hyphens ([A-Z] [a-z], 0-9, _, -).	ans..64	E.g.: 2-XQ001
vads_order_info	Additional order info	ans..255	E.g.: Door code 3125
vads_order_info2	Additional order info	ans..255	E.g.: No elevator
vads_order_info3	Additional order info	ans..255	E.g.: Express
vads_nb_products	Number of items in the cart	n..12	E.g.: 2
vads_product_ext_idN	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.).	an..100	E.g.: `vads_product_ext_id0 = "0123654789123654789"` `vads_product_ext_id1 = "0223654789123654789"` `vads_product_ext_id2 = "0323654789123654789"`
vads_product_labelN	Item name. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).	ans..255	E.g.: `vads_product_label0 = "tee-shirt"` `vads_product_label1 = "Biscuit"` `vads_product_label2 = "Sandwich"`
vads_product_amountN	Price of the item incl. VAT. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).	n..12	E.g.: `vads_product_amount0 = "1200"` `vads_product_amount1 = "800"` `vads_product_amount2 = "950"`
vads_product_typeN	Item type. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).	enum	E.g.: `vads_product_type0 = "CLOTHING_AND_ACCESSORIES"` `vads_product_type1 = "FOOD_AND_GROCERY"` `vads_product_type2 = "FOOD_AND_GROCERY"`
vads_product_refN	Item reference. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).	an..64	E.g.: `vads_product_ref0 = "CAA-25-006"` `vads_product_ref1 = "FAG-B5-112"` `vads_product_ref2 = "FAG-S9-650"`
vads_product_qtyN	Item quantity. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).	n..12	E.g.: `vads_product_qty0 = "1"` `vads_product_qty1 = "2"` `vads_product_qty2 = "2"`
vads_product_vatN	Amount or VAT rate applied to the item. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). The decimal separator is mandatory for displaying a rate. The decimal separator is represented by the "." symbol.	n..12	Populated with an integer, without a decimal separator, for expressing an amount. E.g.: 4525 for EUR 45.25 Populated with a decimal number less than 100, for expressing a rate. E.g.: 20.0 or 19.6532

Value the fieldvads_nb_productswhere the number of the articles in the cart.
We recommend to make populating the field mandatory for taking the cart into account. This implies populating the other fields starting withvads_product_to see the details of the shopping cart.
Value the field vads_product_amountN with the amount for the items in the cart, using the smallest currency unit.
N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).

Value the field vads_product_typeN with the value corresponding to the item type.

N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).

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

Value the field vads_product_labelN with the label of each article in the cart.
N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
Value the field vads_product_qtyN with the quantity of each article in the cart.
N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
Value the field vads_product_refN with the reference of each article in the cart.
N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
Control the value of the field vads_amount. It must correspond to the total amount of the order.

Example of the payment form with cart description "vads_product_xxx" :

<form method="POST" action="https://secure.lyra.com/vads-payment/">
<input type="hidden" name="vads_action_mode" value="INTERACTIVE" />
<input type="hidden" name="vads_amount" value="11000" />
<input type="hidden" name="vads_capture_delay" value="0" />
<input type="hidden" name="vads_ctx_mode" value="PRODUCTION" />
<input type="hidden" name="vads_currency" value="978" />
<input type="hidden" name="vads_nb_products" value="2"/>
<input type="hidden" name="vads_product_amount0" value="5000" />
<input type="hidden" name="vads_product_label0" value="produit1" />
<input type="hidden" name="vads_product_qty0" value="2" />
<input type="hidden" name="vads_product_ref0" value="ref1" />
<input type="hidden" name="vads_product_amount1" value="1000" />
<input type="hidden" name="vads_product_label1" value="produit2" />
<input type="hidden" name="vads_product_qty1" value="1" />
<input type="hidden" name="vads_product_ref1" value="ref2" />
<input type="hidden" name="vads_order_id" value="CD100000857" />
<input type="hidden" name="vads_page_action" value="PAYMENT" />
<input type="hidden" name="vads_payment_config" value="SINGLE" />
<input type="hidden" name="vads_site_id" value="12345678" />
<input type="hidden" name="vads_trans_date" value="20190627145218" />
<input type="hidden" name="vads_trans_id" value="571381" />
<input type="hidden" name="vads_version" value="V2" />
<input type="hidden" name="signature" value="xYw1UnU3BACGhf3UEyqbQzpwuvZDEkCAWAE5fgbtfxI="/>
<input type="submit" name="payer" value="Payer"/></form>

Categories

Tags

Transmitting order details