Payment page customization is achieved using the template object.

With custom fields, merchants can utilize customizable fields that can store additional data or display specific information on a payment page

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

For each payment page, a template is used.

There are Il existe 2 types de pages de paiement AXEPTA qui peuvent être personnalisées à l'aide des customfieldsof AXEPTA payment pages that can be customized using custom fields.

Nom	API
Formulaire de choix des moyens de paiement (Hosted Payment Page)	/payments/sessions
Formulaire de paiement par carte Card Payment form (Payssl)	/payments

Liste des

List of customFields

ParamètreParameter	Format	CND	Description
template.customFields.customField1	ans...50	OMontant et devise du paiement	Amount and Currency
template.customFields.customField2	ans...50	ORéférence commande	Order Reference
template.customFields.customField3	ans...256	O	Merchant Logo du commerçant URL avec le logo du commerçant, taille recommandée Merchant Logo URL (recommended size: 200x100 pixels)
template.customFields.customField4	ans...50	ORéférence facture	Invoice Reference
template.customFields.customField5	ans...50	OInformations sur l'utilisateur	User Information
template.customFields.customField6	ans...50	OAdresse de livraison	Delivery Address
template.customFields.customField7	ans...50	OAdresse de facturation	Billing Address
template.customFields.customField8	ans...50	ONom du champ	Customizable Field Name (header) personnalisable (à la main du commerçant (merchant-defined)
template.customFields.customField9	ans...50	OValeur du champ personnalisable (relatif au champ	Custom Field Value (related to field 8)
template.customFields.customField14	ans...50	OCette option permet de mettre en place l'iframe dans la page de paiement du marchand. Valeur accepté	This option enables the iframe implementation in the merchant's payment page Accepted value: "iframe"

Info

The customFields allow displaying text with line breaks. In this case, you need to add the character "|" in the customField content to indicate a line break.

Example: CustomField6 = Line 1|Line 2|Line 3

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

The customFields that accept the "|" character are

CustomField4, CustomField5, CustomField6, CustomField7

et

, and CustomField9.

Code Block

language	json
title	Exemple objet customFields sur l'API Example with the customFields on the /payments/sessions API
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 (Example of Hosted Payment Page ) contenant des with customFields

Code Block

language	json
title	Exemple d'objet customFields sur l'API Example with the customFields on the /payments API
linenumbers	true

...
"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 Example of Card Payment form with customFields

CustomField14

sur la Page de choix des moyens de paiement (Hosted

on the Hosted Payment Page

)

When the parameter

Lorsque le paramètrecustomField14 = "iframe"sur la Page de choix des moyens de paiement ( is set on the Hosted Payment Page), tous les autres champs personnalisés deviennent invisibles, all other custom fields become invisible.

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

Example of Hosted Payment Page with the customField14

CustomField14

sur le Formulaire de paiement par carte

on the Card Payment form (Payssl)

avec un

customField14

Lorsque le paramètreWhen the parameter customField14 = "iframe", tous les autres champs personnalisés deviennent invisibles, à l'exception du customField1. is set on the Hosted Payment Page, all other custom fields become invisible, except for customField1.

Code Block

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

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

Example of Card Payment form with the customField14

Other Dynamic Parameters (Language, Payment Method Selection)

Additional parameters are available to merchants and can be transmitted unencrypted

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 2

New Version 3

Key

List of customFields

CustomField14

on the Hosted Payment Page

CustomField14

on the Card Payment form (Payssl)

Other Dynamic Parameters (Language, Payment Method Selection)

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

Help

Intranet Tools

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

List of customFields

CustomField14

on the Hosted Payment Page

CustomField14

on the Card Payment form (Payssl)

Other Dynamic Parameters (Language, Payment Method Selection)

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