• France
lyra.com
Search
Categories
Tags
Europe (English)
France
Spain
Europe (English)
India
Home
Implementation
Embedded form (cards)
REST payment API
REST PCI-DSS payment API
REST SEPA API
Hosted payment
Data collection form
File exchange
Mobile payment
Snippets
Plugins
Marketplace
Back Office
Merchant Back Office
Expert Back Office
Guides
Help
FAQ
Video tutorials
Support

Transmitting order details

The merchant can transmit the order details (order reference, description, shopping cart content, etc.).

This information can be found in the transaction details in the Expert Back Office.

  1. Use optional fields according to your requirements. These fields will be returned in the response and will include the value transmitted in the form.
    Field name Description Format Value
    vads_order_info Complementary order info an..255 E.g.: Door phone code 3125
    vads_order_info2 Complementary order info an..255 E.g.: No elevator
    vads_order_info3 Complementary order info an..255 E.g.: Express
    vads_nb_products Number of items in the cart n..12 E.g.: 2
    vads_product_ext_idN Product bar code 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.:

    vads_product_ext_id0 = "0123654789123654789"

    vads_product_ext_id1 = "0223654789123654789"

    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 = "Dated 3 days stay"

    vads_product_label1 = "Private concert"

    vads_product_amountN 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.). n..12 E.g.:

    vads_product_amount0 = "32150"

    vads_product_amount1 = "10700"

    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 = "TRAVEL"

    vads_product_type1 = "ENTERTAINMENT"

    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 = "1002127784"

    vads_product_ref1 = "1002127693"

    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 = "1"

  2. Populate the vads_nb_products field with the number of items contained in the cart.
    Note:
    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 in the Expert Back Office.
    However, if the other fields that start 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 that start with vads_product_.
  3. Populate the vads_product_amountN field 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.).
  4. 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.).
    Value Description
    FOOD_AND_GROCERY Food and grocery
    AUTOMOTIVE Cars / Moto
    ENTERTAINMENT Entertainment / Culture
    HOME_AND_GARDEN Home and gardening
    HOME_APPLIANCE Household appliances
    AUCTION_AND_GROUP_BUYING Auctions and group purchasing
    FLOWERS_AND_GIFTS Flowers and presents
    COMPUTER_AND_SOFTWARE Computers and software
    HEALTH_AND_BEAUTY Health and beauty
    SERVICE_FOR_INDIVIDUAL Services for individuals
    SERVICE_FOR_BUSINESS Services for companies
    SPORTS Sports
    CLOTHING_AND_ACCESSORIES Clothes and accessories
    TRAVEL Travel
    HOME_AUDIO_PHOTO_VIDEO Sound, image and video
    TELEPHONY Telephony
  5. 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.).
  6. 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.).
  7. 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.).
  8. Check the value of the vads_amount field. It must correspond to the total amount of the order.
Recruitment

Head Office :

LYRA NETWORK
109, rue de l’innovation
31670 Labège
FRANCE

2.16.0-doc-1.8