Configure Dynamic Account Button

Use this endpoint to configure a dynamic action button that appears on an account details page and opens your custom workflows application for the selected account. For example, you can display account-related information in a custom way by linking a dynamic action button on an account page to a custom workflows application.

The provider integration connector passes the button configuration, including the button text and the workflows application URL. When the merchant user clicks the button, the request opens your workflows application using the following:

URL format

/work/{marketplaceKey}#/?accountId={account_id}
  • Query parameter name: accountId
  • Hash prefix: Note the #/ before the query string. The URL uses hash routing, so the query string lives after the hash. Your workflows application should read accountId from the hash fragment's query string, not from window.location.search.

Merchant users access this button on the account details page of your banking app.

What this endpoint does

The Create Dynamic Account Button Configuration endpoint defines how an action button is displayed for a specific account.

You can also manage existing configurations with these related endpoints:

Required path parameters

  • customerId (path parameter): The ID of the customer.
  • marketplaceKey (path parameter): The marketplace key of the app that owns the account page.

Required body parameters

  • marketplaceKey (string, required): The marketplace key of your custom app. The button uses this value to redirect the user to the correct workflows application.
  • texts (array of strings, required): The text to display on the button in different languages.
triangle-exclamation

Install the workflows application for the customer before you configure the button. If the application is not installed, the button is not shown.