Dynamic Balance in Ledger Apps

For Ledger Apps with dynamic balance enabled, System Integrators (SIs) can send values to be displayed in the dynamic balance sections on the account view page.

The dynamic balance section can include up to two sections with the following fields each: Title,
Value, Currency, Tooltip Description.

This advanced customisation feature is available through the public API, offering greater control over the user interface and overall user experience.

Enabling Dynamic Balance for Ledger Apps using Public API Endpoint

This documentation article explains how you can enable or disable the dynamic balance feature for Ledger Apps using a public API endpoint.

Steps to Enable or Disable Dynamic Balance:

1. Ensure you have the following information:
   • customerId: A unique identifier for the customer this app belongs to.
   • marketplaceKey: A unique identifier for the ledger app.

The dynamic balance feature is enabled or disabled at the app level using the unique marketplaceKey and customerId values. To avoid overwriting existing custom faculties for other features for your app, ensure you have the current list of custom faculties for the app before making any modifications.

2. Retrieve the current list of custom faculties enabled for the app using Get Custom Faculties endpoint.

3. Construct a payload to enable or disable the dynamic balance feature:
   Enable: {"CAN_SHOW_DYNAMIC_BALANCE" : true} Disable: {"CAN_SHOW_DYNAMIC_BALANCE" : false}
4. Send a PUT request to the following endpoint with the JSON payload to enable or disable the dynamic balance feature, using Update Custom Faculties endpoint

Setting Values for the Dynamic Balance Feature

Once the dynamic balance feature is enabled for your app, you'll need to send the values to be displayed to the end-user within the app through your cloud integration. These values are essential for the proper functioning of the dynamic balance feature.

To set up the dynamic balance values, you'll need to provide the following fields to the integration endpoint:

• Title (localised for different languages)
• Value
• Currency
• Description for "i" (tooltip information, localized for different languages)

Up to 2 objects with these fields can be sent. If no information is provided from the integration, nothing will be displayed in the balance section. Similarly, if only one object is sent, only one section will be displayed in the dynamic balance.

Once the dynamic balance feature is enabled for the app, Toqio will make a call to the integration to retrieve the necessary information for an account using accountId to display the dynamic balance.

An example response from this endpoint should follow the format below:

[  
  \{
    "title": {
      "es": "Saldo personalizado",
      "en": "Custom balance",
      "zh": "自訂餘額"
    },
    "amount": 10.0,
    "currency": "eur",
    "tooltipInformation": {
      "es": "Información para mostrar",
      "en": "Tooltip information to display",
      "zh": "要顯示的訊息"
    }
  },
  \{
    "title": {
      "es": "Saldo extra",
      "en": "Extra balance",
      "zh": "額外餘額"
    },
    "amount": 25.0,
    "currency": "gbp",
    "tooltipInformation": {
      "es": null,
      "en": null,
      "zh": null
    }
  }
]

This response will be used to populate the dynamic balance feature within your ledger app, providing a seamless experience for end-users across different languages and currencies.