Transmitting order details

The merchant can indicate in their payment form if they wish to transmit the order details (order reference, description, shopping cart contents, etc.).

This information can be found in the transaction details in the Merchant Back Office (Shopping cart tab).

  1. Use the fields required for your use case (see chapter Generating a payment form ) to create your payment form.
  2. Use optional fields according to your requirements. These fields will be returned with the response and will include the value transmitted in the form.
    Table 1. Field list - Order details
    Field name Description Format Value
    vads_order_id Order ID ans..64 E.g.: 2-XQ001
    vads_order_info Additional order info an..255 E.g.: Door phone code 3125
    vads_order_info2 Additional order info an..255 E.g.: No elevator
    vads_order_info3 Additional order info an..255 E.g.: Express
    vads_nb_products Number of items in the cart n..12 E.g.: 2
    vads_product_labelN Item name. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). an..255 E.g.:

    vads_product_label0 = "tee-shirt"

    vads_product_label1 = "Biscuit"

    vads_product_label2 = "sandwich"

    vads_product_amountN Item amount. 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 Quantity of items. 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 Item tax. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). n..12  
    vads_shipping_amount Shipping fee amount n..12  
    vads_tax_amount Tax amount for the entire order n..12  
    vads_insurance_amount Insurance amount for the entire order n..12  
  3. Populate vads_nb_products with the number of items contained in the cart.
    Notee:
    This field becomes mandatory for the shopping cart to be taken into account.
    When it is populated, the Shopping cart tab becomes available in the transaction details via the Merchant Back Office.
    However, if the other fields starting with vads_product_ are not populated, the tab will not include any information. For this reason, when populating the vads_nb_products field, it becomes mandatory to populate the other fields starting with vads_product_.
  4. Populate vads_product_amountN with the amount of all the items in the cart in the smallest currency unit.
    N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
  5. Populate 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.).
    Table 2. Valeurs associées à vads_product-type0
    Valeur Description
    FOOD_AND_GROCERY Produits alimentaires et d'épicerie
    AUTOMOTIVE Automobile / Moto
    ENTERTAINMENT Divertissement / Culture
    HOME_AND_GARDEN Maison et jardin
    HOME_APPLIANCE Equipement de la maison
    AUCTION_AND_GROUP_BUYING Ventes aux enchères et achats groupés
    FLOWERS_AND_GIFTS Fleurs et cadeaux
    COMPUTER_AND_SOFTWARE Ordinateurs et logiciels
    HEALTH_AND_BEAUTY Santé et beauté
    SERVICE_FOR_INDIVIDUAL Services à la personne
    SERVICE_FOR_BUSINESS Services aux entreprises
    SPORTS Sports
    CLOTHING_AND_ACCESSORIES Vêtements et accessoires
    TRAVEL Voyage
    HOME_AUDIO_PHOTO_VIDEO Son, image et vidéo
    TELEPHONY Téléphonie
  6. Populate vads_product_labelN with the name of each item contained in the cart.
    N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
  7. Populate vads_product_qtyN with the quantity of each item contained in the cart.
    N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
  8. Populate vads_product_refN with the reference of each item contained in the cart.
    N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
  9. Populate the vads_shipping_amount field with the amount of the shipping fees for the entire order.
    The amount is expressed in the smallest currency unit. E.g.: 3000 for 30,00 EUR.
  10. Populate the vads_tax_amount field with the tax amount for the entire order.
    The amount is expressed in the smallest currency unit. E.g.: 3000 for 30,00 EUR.
  11. Populate the vads_insurance_amount field with the insurance amount for the entire order.
    The amount is expressed in the smallest currency unit. E.g.: 3000 for 30,00 EUR.
  12. Verify the value of the vads_amount field. It must correspond to the total amount of the order.

    Note:

    The used equation is:

    Sum ( vads_product_qty(N) x vads_product_amount(N) ) + vads_shipping_amount + vads_tax_amount + vads_insurance_amount = vads_amount

    If the value specified in the vads_amount field is incorrect, your payment form is rejected because of an amount error.

  13. Compute the value of the signature field using all the fields of your form starting with vads_ (see chapter Computing the signature).

Example of the payment form with cart description:

<form method="POST" action="https://secure.payzen.eu/vads-payment/">
<input type="hidden" name="vads_action_mode" value="INTERACTIVE" />
<input type="hidden" name="vads_amount" value="7500" />
<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_insurance_amount" value="500" />
<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_shipping_amount" value="500" />
<input type="hidden" name="vads_tax_amount" value="500" />
<input type="hidden" name="vads_trans_date" value="20140327145218" />
<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="pay" value="Pay"/></form>