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.

A chaque page de paiement, un template

For each payment page, a template is used.

There are 2 types of AXEPTA payment pages that can be customized using custom fields.

Nom	API
Hosted Payment Page	/payments/sessions
Card Payment form (Payssl)	/payments

List of customFields

Parameter	Format	CND	Description
template.customFields.customField1	ans...50	O	Amount and Currency
template.customFields.customField2	ans...50	O	Order Reference
template.customFields.customField3	ans...256	O	Merchant Logo Merchant Logo URL (recommended size: 200x100 pixels)
template.customFields.customField4	ans...50	O	Invoice Reference
template.customFields.customField5	ans...50	O	User Information
template.customFields.customField6	ans...50	O	Delivery Address
template.customFields.customField7	ans...50	O	Billing Address
template.customFields.customField8	ans...50	O	Customizable Field Name (header) (merchant-defined)
template.customFields.customField9	ans...50	O	Custom Field Value (related to field 8)
template.customFields.customField14	ans...50	O	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

The customFields that accept the "|" character are CustomField4, CustomField5, CustomField6, CustomField7, and CustomField9.

Code Block

language	json
title	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"
        }
	},
...

Example of Hosted Payment Page with customFields

Code Block

language	json
title	Example with the customFields on the /payments API
linenumbers	true

...
"paymentMethods": {
        "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"
            }
       }
    }
}
...

Example of Card Payment form with customFields

CustomField14 on the Hosted Payment Page

When the parameter customField14 = "iframe" is set on the Hosted Payment Page, 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"
        }
	},
...

Example of Hosted Payment Page with the customField14

CustomField14 on the Card Payment form (Payssl)

When the parameter customField14 = "iframe" 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"
            }
       }
    }
...

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:

Language

a2 Enum

O

Langue utilisée pour la page de paiement

Language for Payment Page

Language code of the merchant's payment page : 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

When not mentioned, the language is French by default.

If the user changes the language from the language selector, the chosen language will be displayed during the next visit.

allowedPaymentMethods

Enum

O

Liste des moyens de paiement à afficher dans la page de choix des moyens de paiement (

Payment Methods to Display on Hosted Payment Page

- HPP)

This parameter indicates which payment methods to display on the payment selection page.

If this parameter is not used, the merchant's default configuration is used to display the authorized payment methods.

Possible values can be taken from the allowedPaymentMethods column in the payment methods table (see the Parameter Value Definitions section at the bottom of the

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

Parameter to indicate the card type Display on Card Payment Form

This parameter, derived from the paymentMethods.card objects, indicates the type of card brand to display on the card payment formCe 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 It is not possible to precisely specify the type of card to display on the payment method selection page (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 »

Parameter Value Definitions

«allowedPaymentMethods» parameter

Below are the available payment methods and the corresponding values to be specified in the «allowedPaymentMethods» parameter:

Payment Method	Parameter Value for "allowedPaymentMethods" in API Call to /payments/sessions
Card *See below the list of card brands
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» parameter

Card brands to specify in the 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.

objects

This table lists the exact spelling of different card brands to be specified in the subType parameter of paymentMethods.card objects:

Brand	Marque	Valeur du paramètre (paymentMethods.card) "subType" lors de l'appel à l'API parameter value for API calls to /payments/sessions ou à l'API or /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 3

New Version 4

Key

List of customFields

CustomField14 on the Hosted Payment Page

CustomField14 on the Card Payment form (Payssl)

Other Dynamic Parameters (Language, Payment Method Selection)

Help

Intranet Tools

Page tree

Page History

Versions Compared

Old Version 3

New Version 4

Key

List of customFields

CustomField14 on the Hosted Payment Page

CustomField14 on the Card Payment form (Payssl)

Other Dynamic Parameters (Language, Payment Method Selection)