JavaScript client reference

The JavaScript client allows to create a payment form on your merchant website, using the following code:

For more detailed documentation, go to Getting started: Single payment.

Supported platforms

We make every effort to support all recent versions of the major browsers available on the market.

For security reasons and to deliver the best user experience to the majority of our merchants, we do not support browsers and operating systems that no longer receive security patches.

These browsers represent a minor part of the traffic making payments on the Internet.

We support:

• Internet Explorer from version 10 onwards
• Edge starting from version 17 onwards
• Chrome from version 70 onwards
• Firefox starting from version 64 onwards
• Safari (Desktop and mobile) from version 11 onwards
• Android native browser from Android 5.0 onwards
• All the latest versions of IOS starting from iPhone 4S.

TLS 1.2 must be supported by the browser.

We proactively test most browsers, both mobile and desktop. But it is possible that a mobile + browser combination escapes our vigilance. In this case, please contact our support.

If you want to support a combination that is not taken into account by our JavaScript client, you can implement our redirect form.

Also note that some antivirus or ad-blocker software may block our solution.Please contact support if you notice any improper detection.

Initialization parameters

Various parameters can be defined while loading the JavaScript client. For example, in order to define kr-public-key and kr-post-url-success :

The available parameters are:

General settings:

Use these classes for customizing fields:

Classes to be used for customizing placeholders:

Classes to be used for customizing animated labels (specific to Material Theme):

These parameters can also be overridden with the KR.setFormConfig() method. For example, to override the kr-post-url-success parameter:

KR.setFormConfig({
        'kr-post-url-success': 'https://my.site'
    }).then(({
            KR
        }) => {
            /* there is no error */
        );

Warning, if the kr-post-url-success and kr-get-url-success parameters are defined simultaneously, the POST method will have priority. The same applies to kr-post-url-refused and kr-get-url-refused*.

Events

It is possible to attach custom JavaScript callbacks to different events. The JavaScript client supports the following events:

The following events are obsolete and are no longer supported. They should not be used :.

• KR.onFormReadyListener()
• KR.onFormCreateListener()

All events return promises, allowing you to integrate them into a chain. See Working in asynchronous environment for more information.

KR.onBrandChanged()

The callback defined in KR.onBrandChanged() is called each time a card brand is detected. Example of integration:

The cardInfo object contains the brand property which can take the following values:

• amex
• cb
• mastercard
• maestro
• visa_electron
• Visa

It also contains the BIN of the card, i.e. the first 6 characters of the PAN.

To view the complete list, see the reference documentation of the effectiveBrand parameter here: Payment.

KR.onFormValid()

The callback defined in KR.onFormValid() is called once all the required fields are filled in and the data is valid. Integration example

The cardInfo object contains the brand property which can take the following values:

• amex
• cb
• mastercard
• maestro
• visa_electron
• Visa

It also contains the BIN of the card, i.e. the first 6 characters of the PAN.

To view the complete list, see the reference documentation of the effectiveBrand parameter here: Payment.

KR.onError()

KR.onError() allows to intercept errors before they appear.

Example of interception of error messages:

After that, error messages will automatically appear in the following element, if it is present:

<div id="customerror"></div>

When several errors are generated, they are merged into one single error. The children property will contain the details of all errors:

{
    "errorCode": "CLIENT_300",
    "errorMessage": "Invalid form data",
    "children": [{
        "errorCode": "CLIENT_301",
        "errorMessage": "Invalid card number",
        "field": "pan",
        (...)
    }, {
        "errorCode": "CLIENT_302",
        "errorMessage": "Invalid expiry date",
        "field": "expiryDate",
        (...)
    }, {
        "errorCode": "CLIENT_303",
        "errorMessage": "Invalid security code",
        "field": "securityCode",
        (...)
    }],
    "detailedErrorCode": null,
    "detailedErrorMessage": null,
    (...)
}

For more information on errors, go to: Managing errors (JS client)

KR.onFocus()

Kr.onFocus() allows to be notified when a form field is in focus:

Example of integration:

If the card number field is in focus, the event variable will take the following value:

{
    "field":"pan",
    "formId":"F73867",
    "_type":"krypton/focus"
}

You can also use KR.onBlur() to detect the loss of focus of a field. Its operation is similar to KR.onFocus()

KR.onInstallmentChanged()

KR.onInstallmentChanged() allows you to be notified when the buyer selects the number of installments.

<script type="text/javascript">
    $(document).ready(function(){
          KR.onInstallmentChanged( function({KR, installmentInfo}){
            console.log(installmentInfo)
          });
    });
</script>

The installmentInfo object has the following attributes:

• brand => Brand of the card. Example: "VISA"
• hasInterests => Boolean indicating whether an interest rate applies. Example: false
• installmentCount => Total number of installments. Example: 1
• totalAmount => Total amount, including interest. Example: 20000

KR.onSubmit()

KR.onSubmit() allows to intercept information about the authorized transaction before the form makes a POST to the URL defined with kr-post-success-url.

Example of integration:

The callback receives an object with 2 parameters:

• KR: Reference to the library
• event: Object that contains the newly created transaction.

L'objet contenu dans event est le même que celui posté par le formulaire. Pour plus de détails, rendez-vous ici : retour à la boutique.

The behavior varies depending on the boolean returned by your function:

KR.button.onClick()

KR.button.onClick() allows for custom processing before the JavaScript client validates the form and makes the call to create a transaction. KR.button.onClick() accepts either a callback or a promise as a parameter.

You can stop the execution string by returning false at the end of processing:

KR.onTransactionCreated()

There are 2 callbacks that allow intercepting a newly created transaction:

• KR.onSubmit() : when an accepted transaction is created.
• KR.onError() : When a rejected transaction is created.

KR.onTransactionCreated() intercepts all newly created transactions, whether they are accepted or rejected. KR.onTransactionCreated() accepts either a callback or a promise as a parameter.

The callback receives an object with 2 parameters:

• KR: Reference to the library
• event: Object that contains the newly created transaction.

You can stop the execution string by returning false at the end of processing:

KR.on3dSecureAbort()

During 3D-Secure authentication, the user can choose to cancel. This will cause the 3DS-Secure popIn to close and an abort error. This event will intercept the user's abanbon.

Note that in this case the transaction is not created in real time. A rejected transaction with a 149 error will be created asynchronously, and only if the user has not made a new payment attempt. The creation will take place after a maximum of 10 minutes. To intercept this transaction, you must use IPNs. See General about IPN for more details.

Methods

Several methods are available for interacting with the JavaScript client:

The following methods are obsolete and are no longer supported. They should not be used :.

• KR.validate(): use KR.validateForm()
• KR.registerPlugin()

Gestion de l'affichage en mode PopIn (voir undefined )

Dynamic form management (add, remove DOM):

you can see the Embedded Form Glue GitHub repository for more information.

Managing the payment form submission button:

All events return promises, allowing you to integrate them into a chain. See Working in asynchronous environment for more information.

KR.field.focus()

To give focus to a form field, you can use the KR.field.focus(FIELD_CLASS) method. You must pass the class of the embedded form field as a parameter.

For example, to add a button that will set focus on the expiry date field:

<button type="button" onclick="KR.fields.focus('kr-expiry')">Focus expiry field</button>

KR.setFormConfig()

This method allows to override the initialization parameters , as well as the following elements:

This method returns a promise.

KR.setBrand()

Forces the detection of the payment method.The method takes as parameter the name of the payment method. The supported values are (not exhaustive):.

• VISA
• VISA_DEBIT
• VISA_ELECTRON
• MASTERCARD
• MASTERCARD_DEBIT
• MAESTRO
• AMEX
• CB
• (...)

Caution: If you set another value, it will be sent unchanged to the payment platform. If the value is not supported by your store configuration, no transaction will be created.

To re-enable automatic detection, call KR.setBrand() without any parameters.

KR.validateForm()

This method checks locally if the form is valid. It returns a promise:.

• then() is called when the form is valid. result will be set to null.
• catch() is called when the form is invalid. result contains the details of the error.

Example of a call:

KR.validateForm().then( ({KR, result}) => {

    /* there is no error */
    /* result == null */
    }

)
.catch( ({KR, result}) => {

    /* Get the error message */
    var code = result.errorCode;
    var message = result.errorMessage;
    var myMessage = code + ": " + message;
    console.log(myMessage);

    /* if you have defined a callback using      */
    /* result.onError(), you can trigger it calling: */
    return result.doOnError();
    }

);

Once you have intercepted the errors, you can trigger the KR.onError() event manually by calling result.doOnError();.

Button personalization

The payment button is automatically added to your form using the following code:

There are numerous benefits to using our payment button:

• The labels are translated automatically.
• The amount is automatically formatted and updated.
• We handle the pending transition animation for you
• The button automatically changes to read-only mode if necessary.

If you want to manage the button label yourself, all you need to do is add it as follows:

<button class="kr-payment-button">Custom label</button>

You can also insert a variable that represents the amount and currency. The JavaScript client will automatically replace them:

<button class="kr-payment-button">this will cost %amount-and-currency% !!</button>

Frequently Asked Questions

Here you will find the FAQ about the JavaScript client.

How to correct CORS or "Unable to post message" errors upon payment?

First of all, you must develop from a web server. The access to the test page must be done with http:// and not with file://

If you use the ionic or cordova framework, you must explicitly declare the domain names that can be called by the JavaScript client. To do this, add the folowing in config.xml :

<allow-navigation href="https://static.systempay.fr/static/js/krypton-client/V4.0" />

More information here.

How to configure the CSP (Content Security Policy)

If your website uses CSP (Content Security Policy), you must allow the JavaScript client to create its IFrames. To do this, you must add the following 3 directives:

Example of adding your page head to the meta section:

<meta
  http-equiv="Content-Security-Policy"
  content="
    connect-src https://static.systempay.fr;
    frame-src https://static.systempay.fr;
    script-src https://static.systempay.fr;"
/>

More information on CSP here.

If you use an external fraud detection engine (such as monitor+, clearsale, etc.), you should also add:

Advanced use

To see all the advanced use cases, go to the following articles:

Examples of integration

Depending on the JavaScript framework that you use on your merchant website, several examples of integration are available here