Description

La personnalisation de la page de paiement se fait avec l'objet template.Il est possible d'utiliser un template personnalisé pour le formulaire de carte qui sera intégré au sein de la page de paiement.

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.

Tableau descriptif de l'objet json template

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

nametemplate.customFields.customField1Numéro de Panier / description de la commande customField10

Paramètre	Format	CND	Description
template.
O	Nom du template à utiliser pour la personnalisation de la Page de Paiement.
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
O	?	template.customFields.customField11	O	?	template.customFields.customField12	O	?	template.customFields.customField13	O	?	template.customFields.customField14	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. Valeur accepté "iframe"

Info

Les paramètres Customfield[n] sont configurables dans la requête uniquement en utilisant HTTP GET dont la taille totale est limitée à 2048 octets donc, dans la mesure du possible, nous préconisons une taille maximale limitée à 50 caractères (ans) pour chacun des customFields.Les customFields permettent d'afficher du texte avec retour retour à la ligne. Dans ce cas, il est nécessaire d'ajouter le caractère "|" dans le contenu du customField 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

Code Block

language	json
title	Exemple object templateobjet customFields sur l'API /payments/sessions
linenumbers	true

...
	"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

Image Added

Code Block

language	json
title	Exemple d'objet customFields sur l'API /payments
linenumbers	true

...
"paymentMethods": {
        "integrationType": "HOSTED",
        "type": "CARD",
        "card": {
            "template": { "name" : "Your template",
        		 "customFields": {
           		 	"customField1": "Amount20.00 €",
					"customField2": "merchantReference",
            		"customField3": "Your Logohttps://placehold.co/200x100/png",
					"customField4": "invoiceIdinvoice29351925733931",
            		"customField5": "Field 5 Data+33600000000|john.doe@bnpparibas.com",
					"customField6": "Field 6 Data41 Rue de Valmy|93100 Montreuil",
            		"customField7": "Field 7 Data41 Rue de Valmy|93100 Montreuil",
					"customField8": "Discount",
            		"customField9": "FRI_50|SUM_25"
            }
       }
    }
}
...

Formulaire de paiement par carte (Payssl) contenant des customFields

Image Added

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.

Code Block

language	json
title	Exemple d'objet customFields sur l'API /payments/sessions
linenumbers	true

...	"template": {
        "customFields": {
            "customField1": "20.00 EURO",
			"customField2": "merchantReference",
            "customField3": "https://placehold.co/200x100/png",
			"customField4": "invoiceId",
            "customField5": "+33600000000|john.doe@bnpparibas.com",
			"customField6": "Field 8 Data41 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

Image Added

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.

Code Block

language	json
title	Exemple d'objet customFields sur l'API /payments
linenumbers	true

...
"paymentMethods": {
   "Field 9 Data",
			"customField10": "Field 10 Data     "integrationType": "HOSTED",
        "type": "CARD",
        "card": {
            "template": {
        		 "customFields": {
           		 	"customField1": "20.00 €",
					"customField2": "merchantReference",
            "customField11		"customField3": "https://placehold.co/200x100/png",
					"customField4": "Field 11 Data"invoice29351925733931",
            		"customField5": "+33600000000|john.doe@bnpparibas.com",
					"customField12customField6": "Field 12 Data41 Rue de Valmy|93100 Montreuil",
              "customField13 		"customField7": "41 Rue de Valmy|93100 Montreuil",
					"customField8": "Field 13 DataDiscount",
            		"customField9": "FRI_50|SUM_25",
					"customField14": "iframe"
  
          }
       }
	},    }
...

Formulaire de paiement par carte (Payssl) avec un customField14
Image Added

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 :

en : English
fr : Français
nl : Nederlands

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 moyens de paiement autorisés.

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 des objets paymentMethods.card permet d'indiquer le type de marque de carte à afficher sur le formulaire de paiement par carte.

Info

title	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

Paramètre «subType»

Marques de cartes à indiquer dans les objets paymentMethods.card

Ce tableau liste l'orthographe exacte des différentes marques de cartes à indiquer dans le paramètre subType des objets paymentMethods.card.

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

Code Block

language	json
title	Endpoint /payments/sessions : exemple de code pour l'affichage des marques Cartes Bancaires et VISA sur le formulaire de paiement par carte
linenumbers	true

...
    "allowedPaymentMethods" :  [
      "CARD"
    ],
    "paymentMethods": {
        "card": {
        "subType":[
            "CARTESBANCAIRES",
            "VISA"]
       }
  } 
...

Page tree

Versions Compared

Old Version 24

New Version Current

Key

Description

Liste des customFields

CustomField14 sur la Page de choix des moyens de paiement (Hosted Payment Page)

CustomField14 sur le Formulaire de paiement par carte (Payssl) avec un customField14

Autres paramètres dynamiques (langue, choix des moyens de paiement)

Help

Intranet Tools

Page tree

Page History

Versions Compared

Old Version 24

New Version Current

Key

Description

Liste des customFields

CustomField14 sur la Page de choix des moyens de paiement (Hosted Payment Page)

CustomField14 sur le Formulaire de paiement par carte (Payssl) avec un customField14

Autres paramètres dynamiques (langue, choix des moyens de paiement)