Dictionnaire de données

Le dictionnaire de données présente la liste complète des champs pouvant être utilisés dans le formulaire de paiement.

Il détaille tout d'abord les principales catégories (telles que les informations techniques, les informations sur la commande...). L'ensemble des champs appartenant à une catégorie sont présentés.

Ces tableaux sont présentés de la manière suivante :

  • Nom du champ : nom du paramètre, tel qu'il sera utilisé dans une requête HTTP
  • Format : format des données
  • Description : description du champ
  • Entrée : caractérise un champ à transmettre dans la requête
  • Sortie : caractérise un champ transmis dans la réponse

Le dictionnaire de données présente ensuite le détail pour chacun des champs. Chaque champ est décrit de la manière suivante :

  • Description : description du champ
  • Format : format des données (voir tableau Liste champs et formats ci-dessus)
  • Valeurs possibles : valeurs attendues lorsque le champ doit être valorisé avec des valeurs spécifiques
  • Exemple : exemple de codage correct des données
  • Code erreur : en cas d’erreur dans l’interfaçage entre le site marchand et la plateforme de paiement, cette dernière indiquera par un code numérique le paramètre fautif dans le champ vads_extra_result
  • Remarque : information complémentaire, précision
  • Catégorie : catégorie à laquelle est affilié le champ

Précisions sur les codes erreur :

Code erreur correspond au numéro de l’erreur lors de la soumission d’un formulaire de paiement incorrect.

  • En mode test ce code sera affiché sur la page de paiement.
  • En mode production un e-mail d’alerte sera envoyé en précisant le code erreur et le nom du paramètre incorrect.

Exemple : Erreur 09 correspond à une erreur sur le montant. Le montant envoyé ne respecte donc pas le format requis.