This section details the features related to the Axepta BNP Paribas Online payment page: page type, integration methods, customization options.

This section contains:

Table of Contents

Axepta BNP Paribas Online payment pages

The Axepta BNP Paribas Online solution offers 2 payment pages:

Pages de paiement BNP Paribas payment page:

Payment pages

Payment Page Hosted by Axepta BNP Paribas (Hosted Payment Page)

Display of all payment means that the merchant wishes to offer.

Card Payment Form (Payssl)

Card payment only display

Endpoint

/payments/sessions

/payments (card)

Customization

Dynamic parameters (languages, payment methods)
Customizable fields, also known as CustomFields (details on the order, details on the buyer...) & Logo

Payment experience selection

The merchant can choose between the 2 following payment experiences:

Option	Redirection	iFrame
Overview	Image Added	Image Added
Functioning	The buyer is redirected to the Axepta BNP Paribas Online payment page.	The buyer remains on the merchant's site and the Axepta BNP Paribas Online payment page is displayed within the merchant's site.
Assets	Easiest integration Little development on the merchant's side	The buyer stays on the merchant's site: known and trusted environment The payment tunnel is smooth

Dynamic payment page settings

Payment page languages

The payment page is available in French and English.

If the language is not specified in the API call, then the payment page language corresponds to the browser language.

If the browser language is not available on the payment page, then the payment page is displayed in English.

The user has the option to change the language, once on the payment page thanks to a drop-down menu, at the top right of it.

API call

Code Block

language	json

"language": "fr"

Available languages

Language	Value in the API
French	fr
English	en
Dutch	nl

Display of payment methods on the payment method selection page (Hosted Payment Page)

By default, all available payment methods on the MerchantID are displayed on the payment method selection page.

The merchant has the possibility to restrict and control the payment means displayed to a customer via the 'allowedPaymentMethods' parameter.

Code Block

language	json

 "allowedPaymentMethods" :  [
      "PAYPAL",
      "WERO",
      "CARD"
    ],

Available payment methods

Payment Method	Parameter Value for "allowedPaymentMethods" in API Call to /payments/sessions
Card *See below the list of card brands	CARD
WERO	WERO
APPLEPAY	APPLEPAY
GOOGLEPAY	GOOGLEPAY
PAYPAL	PAYPAL
FLOAPAY	FLOAPAY
BANCONTACT	BANCONTACT
INSTANEA	INSTANEA

Display of payment methods on the card payment form (Payssl)

By default, all available payment methods on the MerchantID are displayed on the payment method selection page.

The merchant has the possibility to restrict and control the card(s) displayed to a customer via the parameter 'paymentMethods.card.subType'.

Code Block

language	json
theme	Confluence

"paymentMethods": {
        "card" : {
			...
            "subType" : ["CARTESBANCAIRES", "VISA","MASTERCARD", "AMEX"],
			...
        },

Available cards

Card	Value in the API
Carte CB	CARTESBANCAIRES
Visa	VISA
MasterCard	MASTERCARD
Amex	AMEX
JCB	JCB
Discover	DISCOVER
Diners	DINERS
UnionPay International (UPI)	CUP

Customizable fields on payment pages

List of customFields

When the merchant decides to use BNP Paribas' standard page, he can insert its own logo and customizes specific fields called dynamic or customizable fields (customFields).

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.

For each payment page, a template is used.

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

NomAPIHosted Payment Page/payments/sessions

Card Payment form (Payssl)

/paymentsList 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

Implementation of the iframe (customField14)

Display of the payment method selection page (Hosted Payment Page) on the merchant site (iframe)

CustomField14 on the Hosted Payment Page

When the parameter 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

Display of the card payment form (Payssl) on the merchant site (iframe)

When the parameter 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

Language for Payment Page

Language code of the merchant's payment page :

en : English
fr : Français
nl : Nederlands

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

Payment Methods to Display on Hosted Payment Page

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 page).

subType

Enum

O

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

Info

title	Info

It is not possible to precisely specify the type of card to display on the payment method selection page (Hosted Payment Page - HPP).

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

CARD

WERO

APPLEPAY

GOOGLEPAYGOOGLEPAYPAYPALPAYPALFLOAPAYFLOAPAY

BANCONTACT

INSTANEA

«subType» parameter

Card brands to specify in the 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(paymentMethods.card) "subType" parameter value for API calls to /payments/sessions or /paymentsCarte AmexAMEX

Carte CB

CARTESBANCAIRES

UnionPay International (UPI)

CUP

Diners

DINERS

Discover

DISCOVER

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 5

New Version Current

Key

Axepta BNP Paribas Online payment pages

Payment experience selection

Dynamic payment page settings

Payment page languages

Display of payment methods on the payment method selection page (Hosted Payment Page)

Display of payment methods on the card payment form (Payssl)

Customizable fields on payment pages

List of customFields

Implementation of the iframe (customField14)

Display of the payment method selection page (Hosted Payment Page) on the merchant site (iframe)

Display of the card payment form (Payssl) on the merchant site (iframe)

Other Dynamic Parameters (Language, Payment Method Selection)

Help

Intranet Tools

Page tree

Page History

Versions Compared

Old Version 5

New Version Current

Key

Axepta BNP Paribas Online payment pages

Payment experience selection

Dynamic payment page settings

Payment page languages

Display of payment methods on the payment method selection page (Hosted Payment Page)

Display of payment methods on the card payment form (Payssl)

Customizable fields on payment pages

List of customFields

Implementation of the iframe (customField14)

Display of the payment method selection page (Hosted Payment Page) on the merchant site (iframe)

Display of the card payment form (Payssl) on the merchant site (iframe)

Other Dynamic Parameters (Language, Payment Method Selection)