@gatefi/js-sdk v0.25.0

Unlimit JS SDK

Full documentation

Get started

Unlimit can be integrated in a variety of ways. The supported integration modes make it possible to find the configuration that is most suitable for your project.

$ yarn add @gatefi/js-sdk

or

$ npm install @gatefi/js-sdk

Once the npm package is installed, you need to configure the constructor of our SDK. For the overlay mode, the simplest configuration will look as follows:

var instance = new gateFiSDK.GateFiSDK({
    merchantId: "testID",
    displayMode: "embedded",
    nodeSelector: "#container",
})

SDK Configuration Options

The Unlimit widget provides multiple customization options that can be used to modify the look of the payment form. The following configuration parameters are available:

Events

Using the .subscribe() и .unsubscribe() methods provided in the Unlimit SDK, the merchant can subscribe/unsubscribe to the widget-related events. It is possible to subscribe to the following events:

• onLoad - the widget is loaded and ready to work (after that, the configuration is sent to the widget).
• onClose - the widget was closed by the customer (after that, the widget dialog is closed). This event is relevant only for the overlay mode.
• onRedirectBack - the widget was redirected by redirectUrl parameter (click to "Back to Shop" button on order status screen).

Below is an example of subscription to widget-related events:

var instance = new gateFiSDK.GateFiSDK({
  merchantId: "testID",
  displayMode: "overlay",
  nodeSelector: "container"
})

instance.subscribe(GateFiEventTypes.onClose, (type, payload) => {
   console.log(type, payload)
})

Callbacks

Using a variety of methods provided in the Unlimit SDK, the merchant can manipulate the widget. The following actions are available:

• hide() - closes the widget dialog (this method is relevant only for the overlay mode).
• setThemeType(type: "dark" | "light") - sets the theme for the widget.
• show() - displays the widget dialog (this method is relevant only for the overlay mode).
• destroy() - removes the instance of the widget (deletes the widget from DOM).