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" |
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.
...
"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
...
"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.
... "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.
...
"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 | 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 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 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 |
...
"allowedPaymentMethods" : [
"CARD"
],
"paymentMethods": {
"card": {
"subType":[
"CARTESBANCAIRES",
"VISA"]
}
}
...