Transmitting shipping details
The merchant can transmit the buyer’s shipping details (e-mail address, title, phone number etc.).
This information can be found in the transaction details in the Lyra Collect Back Office (Buyer tab).
Use optional fields according to your requirements.
These fields will be returned with the response and will include the value transmitted in the form.
| Field name | Description | Format | Value |
|---|---|---|---|
| vads_ship_to_city | City | an..128 | E.g.: Bordeaux |
| vads_ship_to_country | Country code in compliance with the ISO 3166 standard (required for triggering one or more actions if the Shipping country control profile is enabled). | a2 | E.g.: FR |
| vads_ship_to_district | District | ans..127 | E.g.: La Bastide |
| vads_ship_to_first_name | First name | ans..63 | E.g.: Albert |
| vads_ship_to_last_name | Name | ans..63 | E.g.: Durant |
| vads_ship_to_legal_name | Legal name | an..100 | E.g.: D. & Cie |
| vads_ship_to_phone_num | Phone number | ans..32 | E.g.: 0460030288 |
| vads_ship_to_state | State / Region | ans..127 | E.g.: Nouvelle Aquitaine |
| vads_ship_to_status | Allows to specify the type of the shipping address. |
enum |
PRIVATE: for shipping to a private individual COMPANY: for shipping to a company |
| vads_ship_to_street_number | Street number | ans..64 | E.g.: 2 |
| vads_ship_to_street | Postal address | ans..255 | E.g.: Rue Sainte Catherine |
| vads_ship_to_street2 | Second line of the address | ans..255 | |
| vads_ship_to_zip | Zip code | an..64 | E.g.: 33000 |
Example of payment form with shipping details:
<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="4000" /> <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_page_action" value="PAYMENT" /> <input type="hidden" name="vads_payment_config" value="SINGLE" /> <input type="hidden" name="vads_ship_to_city" value="la ville de livraison" /> <input type="hidden" name="vads_ship_to_country" value="FR" /> <input type="hidden" name="vads_ship_to_name" value="le nom du lieu de livraison" /> <input type="hidden" name="vads_ship_to_street" value="la rue pour effectuer la livraison" /> <input type="hidden" name="vads_ship_to_street_number" value="10" /> <input type="hidden" name="vads_ship_to_zip" value="31670" /> <input type="hidden" name="vads_site_id" value="12345678" /> <input type="hidden" name="vads_trans_date" value="20190627143509" /> <input type="hidden" name="vads_trans_id" value="561095" /> <input type="hidden" name="vads_version" value="V2" /> <input type="hidden" name="signature" value="bOIxHAgm4vYUq3oIDCdEPKOWgrB9bHzkfDBEAr1i10A="/> <input type="submit" name="pay" value="Pay"/> </form>