Skip to main content

Widgets

Accrue Pay Web Widgets are small self-contained web components that can be embedded anywhere in your web experience.

They provide information to the user about their wallet balance including available funds status and reward earning potential.

All widgets are customizable to fit the needs of your applications. Your dedicated account manager will assist you with all customizations.

Embedding widgets in HTML​

First make sure that you are loading the main script in your page.

Accrue Pay Script
<html>
  <head>
    <script
      data-script="accrue-pay"
      defer
      src="https://pay[-sandbox].accruesavings.com/main.js"
      data-client-id="{your-client-id}"
    ></script>
  </head>
</html>

To display a widget, on any page where you have the main script loaded, place HTML tags using the following template:

Accrue Pay Widget Components
<accrue-pay wiget="{widget-name}"></accrue-pay>

Loading required data​

Some widgets require user-specific data not accessible publicly. To properly load the data, you'll need to fetch it using the Merchant API and forward it to the Accrue Pay main script.

These endpoints are privileged. Please make sure you authenticate the request with your secret.

Server rendered​

If you render your HTML server-side, make a GET HTTP request for the data your used widgets requires. Please refer to the Widgets API Reference for all available endpoints.

For example, if you are using Wallet widgets, you'll need to make a request using /api/v1/widgets/wallet/:walletId.

The response will be in the following format:

Accrue Pay Widget Data Example
{
  "data": {
    "id": "wwd_123e4567-e89b-12d3-a456-426614174000",
    "type": "WalletWidgetData",
    "attributes": {
      "payload": "YmFzZTY0IGVuY29kZWQgZGF0YQ=="
    }
  }
}

Now, the only step left is to forward the value of data.attributes.payload to the main script:

Accrue Pay Script With Widget Data
<html>
  <head>
    <script
      data-script="accrue-pay"
      defer
      src="https://pay[-sandbox].accruesavings.com/main.js"
      data-client-id="{your-client-id}"
      data-wallet-widget="{data.attributes.payload}"
    ></script>
  </head>
</html>

Client fetched​

If you prefer to configure Accrue Pay client-side, you'll need to implement a new endpoint in your own API, that will leverage Accrue's Merchant API in the background. E.g. you could decide to implement the following endpoint GET:/api/accrue-wallet-widget.

In your back-end logic make sure to make a GET HTTP request for the data your used widgets requires. Please refer to the Widgets API Reference for all available endpoints.

For example, if you are using Wallet widgets, you'll need to make a request using /api/v1/widgets/wallet/:walletId.

The response will be in the following format:

Accrue Pay Widget Data Example
{
  "data": {
    "id": "wwd_123e4567-e89b-12d3-a456-426614174000",
    "type": "WalletWidgetData",
    "attributes": {
      "payload": "YmFzZTY0IGVuY29kZWQgZGF0YQ=="
    }
  }
}

Return the value of data.attributes.payload as part of your API endpoint response.

Once your API successfully returns a response to your client, call the following function to set the widget data:

Accrue Pay Set Widget Data Example
window.accruePay.setWalletWidgetData("{payload}");

Passing the cart total value​

Some widgets require the current cart total value to be able to support additional calculations.

The amount passed needs always to be a positive integer representing the amount in the smallest currency unit (e.g., 100 cents for $1.00)

During the initial load of your page, please wait for the Accrue Pay script to be ready before calling the following method to update the amount:

Accrue Pay Set Amount Initial Load Example
document.addEventListener("AccruePay::Ready", () => {
  window.accruePay.setAmount(9999);
});

You can always update the amount afterward, whenever it changes, by calling again the following method:

Accrue Pay Set Amount Example
window.accruePay.setAmount(9999);

Wallet Widgets​

To fetch required data for "Wallet Widgets", please use the following Merchant API endpoint: GetWalletWidgetData

Balance​

Used to display a user's available wallet balance and to allow them to apply that balance to a given order.

Wallet Balance Widget
<accrue-pay wiget="wallet-balance"></accrue-pay>
Wallet Balance Widget
Example calculations​
Wallet Balance Widget Details

On apply balance toggle event​

Accrue Pay - Go to Wallet
<html>
  <head>
    <script
      data-script="accrue-pay"
      defer
      src="https://pay[-sandbox].accruesavings.com/main.js"
      data-client-id="{your-client-id}"
      data-wallet-widget="{data.attributes.payload}"
    ></script>

    <script>
      document.addEventListener("AccruePay::Ready", () => {
        // Type of `payload`: { isApplied: boolean; amount: number; }
        window.accruePay.onApplyBalanceToggle((payload) => {
          // Your own logic whenever the apply balance is toggled
          console.log("APPLY BALANCE TOGGLED", payload);
        });
      });
    </script>
  </head>

  <body>
    <accrue-pay wiget="wallet-balance"></accrue-pay>
  </body>
</html>

Rewards Preview​

Used to display the rewards a user will earn for completing a given purchase.

Wallet Rewards Preview Widget
<accrue-pay wiget="wallet-rewards"></accrue-pay>
Wallet Rewards Preview Widget

Payment Success​

Used to display the rewards a user earned to their wallet for completing a purchase.

Wallet Payment Success Widget
<accrue-pay wiget="wallet-payment-success"></accrue-pay>
Wallet Payment Success Widget

Go to wallet event​

Accrue Pay - Go to Wallet
<html>
  <head>
    <script
      data-script="accrue-pay"
      defer
      src="https://pay[-sandbox].accruesavings.com/main.js"
      data-client-id="{your-client-id}"
      data-wallet-widget="{data.attributes.payload}"
    ></script>

    <script>
      document.addEventListener("AccruePay::Ready", () => {
        window.accruePay.onGoToWallet(() => {
          // Your own logic to open the Accrue wallet widget
          console.log("GO TO WALLET PRESSED");
        });
      });
    </script>
  </head>

  <body>
    <accrue-pay wiget="wallet-earned-rewards"></accrue-pay>
  </body>
</html>