Construire le formulaire de paiement FacilyPay

L’intégration du paiement 3-4 fois par carte bancaire avec FacilyPay nécessite la transmission d’un certain nombre de paramètres dans le formulaire de paiement, ainsi que certaines restrictions sur les paramètres existants.

Nous indiquons ici les paramètres qui sont pris en compte pour un paiement FacilyPay avec leurs éventuelles restrictions.

  1. Utilisez les champs présents dans le tableau ci-dessous pour valoriser les informations techniques obligatoires sur le formulaire de paiement.
    Nom du champ Description Format Requis Valeur
    vads_action_mode Mode d’acquisition des données de la carte string (enum) oui INTERACTIVE
    vads_ctx_mode Mode de fonctionnement string (enum) oui Les valeurs possibles sont :

    - TEST pour des transactions de test.

    - PRODUCTION pour des transactions réelles.

    vads_page_action Action à réaliser string (enum) oui PAYMENT
    vads_site_id Identifiant de la boutique n8 oui Ex : 12345678
    vads_version Version du protocole d’échange string (enum) oui V2
    Précisions sur certains champs :
    vads_action_mode
    Seule la valeur INTERACTIVE peut être valorisée. Il s'agit d'un paiement avec redirection. L'acheteur saisit les informations de la carte sur la page de paiement.
    vads_page_action
    Seule la valeur PAYMENT peut être valorisée. Cette valeur permet de réaliser des paiements.
  2. Utilisez les champs présents dans le tableau ci-dessous pour valoriser les informations obligatoires sur la transaction devant figurer dans le formulaire de paiement.
    Nom du champ Description Format Requis Valeur
    vads_amount Montant du paiement (dans sa plus petite unité monétaire) n..12 oui Ex : 3000 pour 30,00 EUR
    vads_capture_delay Délai avant remise en banque n..3 oui 0
    vads_currency Code de la devise Euro n3 oui 978
    vads_payment_config Type de paiement string (enum) oui SINGLE
    vads_trans_id Numéro de la transaction n6 oui Ex : 123456
    vads_order_id Numéro de la commande an9 oui Ex : 123456789
    vads_validation_mode Mode de validation string (enum) oui 0
    vads_trans_date Date et heure UTC du formulaire de paiement n14 oui Ex : 20150113130025
    Précisions sur certains champs :
    vads_currency
    Seule la devise Euro peut être valorisée. Son code est 978.

    vads_order_id

    Cet identifiant est unique et composé de 9 caractères alpha numériques.

    Le site marchand ne peut pas réutiliser le même order_id si celui-ci a déjà été utilisé sur une annulation ou un paiement refusé.

    vads_trans_id
    Cet identifiant est composé de 6 caractères numérique et doit être unique pour chaque transaction pour une boutique donnée sur la journée.
    vads_validation_mode
    Seule la validation automatique peut être paramétrée. Le paiement sera remis de manière automatique à la banque.
  3. Utilisez les champs présents dans le tableau ci-dessous pour valoriser les informations obligatoires sur la commande devant figurer dans le formulaire de paiement.
    Nom du champ Description Format Requis Valeur
    vads_nb_products Nombre de produits contenu dans le panier n..12 oui Ex : 2
    vads_product_amountN Montant du produit N n..12 oui Ex : 100
    vads_product_labelN Libellé du produit N an..127 oui Ex : mon produit
    vads_product_qtyN Quantité de chacun des produits n..12 oui Ex : 1
    vads_product_refN Référence pour chacun des produits an..64 oui Ex : 1
    vads_product_typeN Type de produit string (enum) oui Ex : SPORTS
    Précisions sur certains champs :
    vads_product_amountN, vads_product_labelN, vads_product_qtyN, vads_product_refN et vads_product_typeN
    N correspond à l'indice de l'article (0 pour le premier, 1 pour le deuxième etc...).
    vads_product_typeN
    Les valeurs possibles sont présentées dans le tableau ci-dessous :
    Tableau 1. 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
  4. Utilisez les champs présents dans le tableau ci-dessous pour valoriser les informations obligatoires sur l'acheteur devant figurer dans le formulaire de paiement.
    Nom du champ Description Format Requis Valeur
    vads_cust_title Civilité de l'acheteur string   Ex : M, Mme ou Mlle
    vads_cust_last_name Nom de l'acheteur an..63 oui Ex : Dupont
    vads_cust_first_name Prénom de l'acheteur an..63 oui Ex : Jean
    vads_cust_address Rue de l’acheteur.

    Peut contenir espace, virgule, point, apostrophe, tiret et slash (/)

    ans..255 oui Ex : rue du test
    vads_cust_zip Code postal de l’acheteur

    n5

    oui Ex : 31000
    vads_cust_city Ville de l’acheteur

    Peut contenir espace, slash, tiret et apostrophe.

    an..128 oui Ex : Toulouse
    vads_cust_cell_phone Numéro de téléphone portable de l'acheteur

    de 0 à 9 sans espace

    n10   Ex : 0612345678
    vads_cust_phone Numéro de téléphone de l'acheteur sans espace n10   Ex : 0123456789
    vads_cust_phone Numéro de téléphone de l'acheteur sans espace n10   Ex : 0123456789
    vads_cust_country Permet de spécifier le code du pays de l’acheteur à la norme ISO 3166.

    Seul le code pays de la France peut être valorisé.

    a2 oui FR
    vads_cust_email Adresse e-mail de l’acheteur. ans..255 oui Ex: prenom.nom@exemple.fr
    vads_cust_id Référence de l’acheteur sur le site marchand.

    Cette référence ne doit comporter ni espace, ni caractère spécial ou accentué.

    an..8

      Ex : 12345678
    vads_cust_status Type d'acheteur string (enum) oui

    PRIVATE

    Précisions sur certains champs :
    vads_cust_country
    Seule la France peut être valorisée. Son code (norme ISO 3166) est FR.
    vads_cust_status
    Seule la valeur PRIVATE peut être valorisée (particulier). Une société (COMPANY) ne peut bénéficier de ce moyen de paiement.
  5. Utilisez les champs présents dans le tableau ci-dessous pour valoriser les informations obligatoires sur la livraison devant figurer dans le formulaire de paiement.
    Nom du champ Description Format Requis Valeur
    vads_ship_to_city Ville an..128 oui Labège
    vads_ship_to_country Code pays suivant la norme ISO 3166 a2 oui FR
    vads_ship_to_delay Délai de livraison string (enum) non Ex : IMMEDIATE

    Donnée obligatoire si le champ vads_ship_to_speed est valorisé à PRIORITY

    vads_ship_to_delivery_

    company_name

    Nom du transporteur ans..127 oui Ex : mon transporteur
    vads_ship_to_first_name Prénom ans..63 oui Jean
    vads_ship_to_last_name Nom ans..63 oui Dupont
    vads_ship_to_phone_num Numéro de téléphone n10 oui Ex : 0612345678
    vads_ship_to_speed Mode de livraison (rapidité) string (enum) oui Ex : STANDARD
    vads_ship_to_status Type d'adresse de livraison string (enum) oui Ex : PRIVATE
    vads_ship_to_street Adresse postale. ans..127 oui rue de l'innovation
    vads_ship_to_street2 Complément ou suite ou détail de l'adresse ans..127    
    vads_ship_to_type Type de livraison string (enum) oui Ex : RECLAIM_IN_SHOP
    vads_ship_to_zip Code postal an..64 oui 31670
    Remarque : dès l'instant où vads_ship_to_zip est valorisé, l'ensemble des champs relatifs à la livraison deviennent obligatoires.
    Précisions sur certains champs :
    vads_cust_first_name et vads_cust_last_name
    Ces champs peuvent être valorisés avec :
    • des caractères alphabétiques (a-z et A-Z)
    • des caractères accentués
    • des caractères spéciaux : espace, barre oblique, tiret, apostrophe

      Ces champs ne peuvent contenir de valeur numérique.

    vads_ship_to_speed
    Les valeurs possibles sont les suivantes :
    • STANDARD pour un délai de livraison normal.
    • EXPRESS pour un délai de livraison rapide.
    • PRIORITY pour un délai de livraison personnalisé rapide (Click & Collect).
      La valeur PRIORITY implique l'utilisation du champ vads_ship_to_delay.
    vads_ship_to_delay
    Les valeurs possibles sont les suivantes :
    • INFERIOR_EQUALS pour un délai de livraison inférieur ou égal à 1 heure.
    • SUPERIOR pour un délai de livraison supérieur à 1 heure.
    • IMMEDIATE pour un délai de livraison immédiat.
    • ALWAYS pour un délai de livraison 24h/24 et 7j/7.
    vads_ship_to_status
    Les valeurs possibles sont :
    • PRIVATE pour une livraison à domicile.
    • COMPANY pour une livraison dans une entreprise.
    vads_ship_to_type
    Les valeurs possibles sont les suivantes :
    • RECLAIM_IN_SHOP

      Retrait de la marchandise en magasin.

    • RELAY_POINT

      Retrait dans un réseau de points de retrait tiers (Kiala, Alveol, etc).

    • RECLAIM_IN_STATION

      Retrait dans un aéroport, une garde ou une agence de voyage.

    • PACKAGE_DELIVERY_COMPANY

      Livraison par transporteur (Colissimo, UPS, etc).

    • ETICKET

      Emission d'un billet électronique, téléchargement.

  6. Ajoutez des fonctions complémentaires selon vos besoins. Par exemple, la gestion de la sélection de l'option de paiement (voir chapitre Gérer la sélection de l'option de paiement).
    Des fonctions complémentaires sont présentées dans le Guide d'implémentation API Formulaire.
  7. Calculez la valeur du champ signature en utilisant l’ensemble des champs de votre formulaire, dont le nom commence par vads_ (voir chapitre Calculer la signature).