La personnalisation de la page de paiement se fait avec l'objet template.
Avec les customfields, le marchand peut utiliser les champs personnalisables pouvant stocker des données supplémentaires ou afficher des informations spécifiques sur une page de paiement.
A chaque page de paiement, un template
Il existe 2 types de pages de paiement AXEPTA qui peuvent être personnalisées à l'aide des customfields.
| Nom | API |
|---|---|
| Formulaire de choix des moyens de paiement (Hosted Payment Page) | /payments/sessions |
Formulaire de paiement par carte (Payssl) | /payments |
Liste des customFields
Paramètre | Format | CND | Description |
|---|---|---|---|
template.customFields.customField1 | ans...50 | O | Montant et devise du paiement |
template.customFields.customField2 | ans...50 | O | Référence commande |
template.customFields.customField3 | ans...256 | O | Logo du commerçant URL avec le logo du commerçant, taille recommandée 200x100 pixels |
template.customFields.customField4 | ans...50 | O | Référence facture |
template.customFields.customField5 | ans...50 | O | Informations sur l'utilisateur |
template.customFields.customField6 | ans...50 | O | Adresse de livraison |
template.customFields.customField7 | ans...50 | O | Adresse de facturation |
template.customFields.customField8 | ans...50 | O | Nom du champ (header) personnalisable (à la main du commerçant) |
template.customFields.customField9 | ans...50 | O | Valeur du champ personnalisable (relatif au champ 8) |
template.customFields.customField14 | ans...50 | O | Cette option permet de mettre en place l'iframe dans la page de paiement du marchand. |
Les customFields permettent d'afficher du texte avec retour à la ligne. Dans ce cas, il est nécessaire d'ajouter le caractère "|" dans le contenu du customField pour indiquer le retour à ligne.
Exemple : CustomField6 = Ligne 1|Ligne 2|Ligne 3
Les CustomFields qui acceptent le signe "|" sont CustomField4, CustomField5, CustomField6, CustomField7 et CustomField9
...
"template": {
"customFields": {
"customField1": "20.00 €",
"customField2": "merchantReference",
"customField3": "https://placehold.co/200x100/png",
"customField4": "invoice29351925733931",
"customField5": "+33600000000|john.doe@bnpparibas.com",
"customField6": "41 Rue de Valmy|93100 Montreuil",
"customField7": "41 Rue de Valmy|93100 Montreuil",
"customField8": "Discount",
"customField9": "FRI_50|SUM_25"
}
},
...
Formulaire de choix des moyens de paiement (Hosted Payment Page) contenant des customFields
...
"paymentMethods": {
"integrationType": "HOSTED",
"type": "CARD",
"card": {
"template": {
"customFields": {
"customField1": "20.00 €",
"customField2": "merchantReference",
"customField3": "https://placehold.co/200x100/png",
"customField4": "invoice29351925733931",
"customField5": "+33600000000|john.doe@bnpparibas.com",
"customField6": "41 Rue de Valmy|93100 Montreuil",
"customField7": "41 Rue de Valmy|93100 Montreuil",
"customField8": "Discount",
"customField9": "FRI_50|SUM_25"
}
}
}
}
...
Formulaire de paiement par carte (Payssl) contenant des customFields
CustomField14 sur la Page de choix des moyens de paiement (Hosted Payment Page)
Lorsque le paramètre customField14 = "iframe" sur la Page de choix des moyens de paiement (Hosted Payment Page), tous les autres champs personnalisés deviennent invisibles.
... "template": {
"customFields": {
"customField1": "20.00 EURO",
"customField2": "merchantReference",
"customField3": "https://placehold.co/200x100/png",
"customField4": "invoiceId",
"customField5": "+33600000000|john.doe@bnpparibas.com",
"customField6": "41 Rue de Valmy|93100 Montreuil",
"customField7": "41 Rue de Valmy|93100 Montreuil",
"customField8": "Discount",
"customField9": "FRI_50|SUM_25",
"customField14": "iframe"
}
},
...
Page de choix des moyens de paiement (Hosted Payment Page) avec un customField14
CustomField14 sur le Formulaire de paiement par carte (Payssl) avec un customField14
Lorsque le paramètre customField14 = "iframe", tous les autres champs personnalisés deviennent invisibles, à l'exception du customField1.
...
"paymentMethods": {
"integrationType": "HOSTED",
"type": "CARD",
"card": {
"template": {
"customFields": {
"customField1": "20.00 €",
"customField2": "merchantReference",
"customField3": "https://placehold.co/200x100/png",
"customField4": "invoice29351925733931",
"customField5": "+33600000000|john.doe@bnpparibas.com",
"customField6": "41 Rue de Valmy|93100 Montreuil",
"customField7": "41 Rue de Valmy|93100 Montreuil",
"customField8": "Discount",
"customField9": "FRI_50|SUM_25",
"customField14": "iframe"
}
}
}
...
Formulaire de paiement par carte (Payssl) avec un customField14
Autres paramètres dynamiques (langue, choix des moyens de paiement)
D’autres paramètres sont mis à la disposition du commerçant et peuvent être transmis non chiffrés :
Language | a2 (enum) | O | Langue utilisée pour la page de paiement | Code pour la langue de la page de paiement du commerçant :
Si non mentionné, la langue par défaut est le français. Si l'utilisateur change de langue à partir du sélecteur de langue, c'est celle choisie qui sera affichée lors de la visite suivante. |
allowedPaymentMethods | Enum | O | Liste des moyens de paiement à afficher dans la page de choix des moyens de paiement (Hosted Payment Page - HPP) | Ce paramètre permet d'indiquer les moyens de paiement à afficher sur la page de choix des moyens de paiement. Si ce paramètre n'est pas utilisé, la configuration par défaut du niveau du commerçant est utilisée pour afficher les méthodes de paiement autorisées. Les valeurs possibles peuvent être prises dans la colonne allowedPaymentMethods du tableau des modes de paiement (Voir la section Définitions des valeurs des paramètres en bas de la page). |
subType | Enum | O | Paramètre utilisé pour indiquer le type de carte à afficher sur la formulaire de paiement par carte | Ce paramètre, découlant de l'objet paymentMethods.card permet d'indiquer le type de marque de carte à afficher sur le formulaire de paiement par carte. Info Il n'est pas possible d'indiquer précisément le type de carte à afficher sur la page de choix des moyens de paiement (Hosted Payment Page - HPP). |
Definition des valeurs des paramètres
Paramètre « allowedPaymentMethods»
Veuillez trouver ci-dessous les différents moyens de paiement disponibles et les valeurs à renseigner dans le paramètre « allowedPaymentMethods »
Moyen de paiement | Valeur du paramètre « allowedPaymentMethods » lors de l'appel à l'API /payments/sessions uniquement |
Carte *Voir la liste des marques de cartes ci-dessous | CARD |
WERO | WERO |
APPLEPAY | APPLEPAY |
| GOOGLEPAY | GOOGLEPAY |
| PAYPAL | PAYPAL |
| FLOAPAY | FLOAPAY |
BANCONTACT | BANCONTACT |
INSTANEA | INSTANEA |
Marques de cartes à indiquer dans l'object paymentMethods
L’orthographe exacte des différentes marques de cartes pour le paramètre subType :
| Marque | Valeur du paramètre (paymentMethods.card) "subType" lors de l'appel à l'API /payments/sessions ou à l'API /payments |
| Carte Amex | AMEX |
Carte CB | CARTESBANCAIRES |
UnionPay International (UPI) | CUP |
Diners | DINERS |
Discover | DISCOVER |
JCB | JCB |
Carte MasterCard | MasterCard |
Carte VISA | VISA |
...
"allowedPaymentMethods" : [
"CARD"
],
"paymentMethods": {
"card": {
"subType":[
"CARTESBANCAIRES",
"VISA"]
}
}
...