Widget de confirmation de commande

Ce Widget est lié à l’API IMA As A Service.

Le widget se décompose en plusieurs écrans :

1. Récapitulatif de la commande ou Devis complémentaire (dans le cas d’un avenant)
2. Paiement de la commande dans un widget intégré
3. Confirmation
4. Erreur technique

Utilisation

Pour pouvoir mettre en place le widget, un échange préalable avec le support est nécessaire pour déclarer l’url qui intègrera le widget et obtenir la clé à utiliser.

Une fois cette étape effectuer, intégrer le code javascript suivant, comprenant l’appKey fournie lors des échanges :

<script type="text/javascript" src="https://widget.ima.eu/widgets/payment/v1/widget?key={{appKey}}"></script>

Puis placer un élément HTML portant l’id ImaPayment :

<div id="ImaPayment" data-token="{{string}}" lang="{{alpha-2}}" withConfirmationPage="{{boolean}}" returnUrlSuccess="{{string}}" returnUrlError="{{string}}" redirectTimeOut="{{integer}}">

Avec :

• id : Identifiant technique de l’élément contenant le widget, qui doit toujours être égal à « ImaPayment »
• data-token : Le token contient les informations nécessaires à l’initialisation du widget, à renseigner dynamiquement : obtenu lors de la génération du lien/token
• lang : Permet au consommateur de forcer la langue du widget
• returnUrlSuccess : Indique l’URL de redirection vers une page externe de confirmation de commande en cas de paiement réussi si withConfirmationPage = false
• returnUrlError : Indique l’URL de redirection vers une page externe d’erreur en cas d’échec du paiement
  ou d’erreur interne, si withConfirmationPage = false
• redirectTimeOut : Détermine le temps en millisecondes s’écoulant avant qu’une redirection ait lieu en cas d’erreur interne au widget, si withConfirmationPage = false

Descriptif de l’attribut withConfirmationPage :

1. Si la valeur est true :
   1. Affiche la page de confirmation de paiement interne au widget en cas de paiement
      réussi
   2. Renvoie vers la page de récapitulatif de commande si le paiement a échoué
   3. Affiche la page d’erreur interne au widget en cas d’erreur propre à celui-ci, sans
      aucune redirection
2. Si la valeur est false :
   1. Redirige vers l’URL saisie dans returnUrlSuccess en cas de paiement réussi
   2. Redirige vers l’URL saisie dans returnUrlError en cas d’échec du paiement
   3. Affiche la page d’erreur interne au widget en cas d’erreur propre à celui-ci, puis applique une redirection vers returnUrlError après un délai configurable avec l’attribut redirectTimeOut

Si returnUrlSuccess et/ou returnUrlError ne sont pas renseignés alors que withConfirmationPage vaut false, c’est le comportement avec withConfirmationPage = true qui s’applique pour chaque valeur returnUrl manquante.