• France
état des services
démonstrations
assistance
FAQContacter le support
Tutoriels vidéo
Rechercher
Catégories
Tags
France
France
Espagne
Europe (Anglais)
Inde
Accueil
Cas d'usage
Créer un paiement
Créer un paiement en plusieurs fois
Proposer un paiement complémentaire
Créer un paiement par alias (token)
Créer un lien de paiement
Créer un abonnement
Gérer vos abonnements
Gérer vos transactions (rembourser,...)
Analyser vos journaux
Docs API
Formulaire embarqué
API REST
Formulaire en redirection
SDK Mobile
Échange de fichiers
Mandats SEPA par API REST
Exemples de code
Moyens de paiement
Modules de paiement
Marketplace
Guides
Back Office Marchand
Back Office Expert
Guides fonctionnels

paymentOfferInfo

Le type paymentOfferInfo permet de décrire les paramètres pour une création d’un ordre de paiement par e-mail.

Tableau 1. Type paymentOfferInfo
Nom du champ Type Description Requis
shopId Long n8 Identifiant de la boutique.
reference string an24 L’identifiant de la transaction ou référence de la commande  
ctxMode string Contexte de sollicitation de la plateforme de paiement :
  • TEST
  • PRODUCTION
amount long Montant de la commande, exprimé dans l’unité indivisible de la devise ( (le centime pour l'euro)).
currency int Code de la devise de la transaction (norme ISO 4217).

Ex : 978 pour l'euro (EUR)
locale string Code de la langue d'envoi des notifications (e-mail ou sms de confirmation de paiement)

Liste des langues disponibles

Langue Codification ISO 639-1
Allemand de
Anglais en
Chinois zh
Espagnol es
Français fr
Italien it
Japonais ja
Néerlandais nl
Polonais pl
Portugais pt
Russe ru
Suédois sv
message* string an2000 Corps de l’e-mail envoyé.
recipients Array [1-100] Liste des adresses e-mails.

Un ordre est créé par destinataire (min 1, max 100).
subject* string an255 Objet de l’e-mail envoyé.
validationMode int Mode de validation des paiements :
  • 0 = Automatique (par défaut)
  • 1 = Manuel.
validity dateTime Date de validité de l’ordre.

Ne peut être antérieure à la date courante et ne peut dépasser 90 jours.

Date exprimée au format ISO 8601 définit par W3C.

Exemple : 2016-07-16T19:20:00Z.
sendMail boolean Envoie l’e-mail au destinataire si égal à true.
expandedData string Permet d’ajouter n’importe quel champ du formulaire de façon dynamique.

Exemples :

Créer un ordre de paiement nfois et en anglais
vads_payment_config=MULTI:first=1000;
count=3;period=30&vads_language=en

Proposer l'enregistrement de la carte lors du paiement

vads_page_action=ASK_REGISTER_PAY

Réaliser un paiement en 1 clic

vads_identifier=9685332147463547785213301
  
device string valeur possible = « MAIL »
template string

Nom du modèle de l'e-mail à utiliser pour l'ordre de paiement.

  

* Les champs message et subject deviennent optionnels si le champ template est renseigné.

Exemple d’initialisation en JAVA

private PaymentOfferInfo initInfo() 
{
PaymentOfferInfo info = new paymentOfferInfo();
info.setShopId(PDV_ID);
info.setAmount(10000);
info.setCurrency(978);
info.setCtxMode("PRODUCTION");
info.getRecipients().add(MAIL1);
info.getRecipients().add(MAIL2);
info.setLocale("fr");
info.setMessage(BODY);
info.setReference("REF-ORDRE");
info.setDevice(PaymentDevice.MAIL.toString());
info.setSubject(SUBJECT);
info.setValidationMode(0);
info.setValidity(UtilWsTests.getNewDate(90));
info.setSendMail(true);
info.setExpandedData("vads_payment_config=MULTI:first=1000;count=3;period=30&vads_language=en");
return info;
}
Nous recrutons
Mentions légales
Charte de Protection des Données Personnelles
25.25.0-1.11