Skip to main content

7 posts tagged with "ui-components"

View All Tags

New capability in the Payment Fund UI Component for users to choose if to fund the payment run manually or through Open Banking

· 2 min read

We have enhanced the Payment Fund UI component by introducing a new funding options selection screen. This update allows users to choose between funding a payment run manually or through the embedded Open Banking flow.

Effective:

  • Sandbox: 18 March 2025
  • Production: 18 March 2025

What's Changing?

sers will now see a new screen in the Payment Run Fund UI component, prompting them to select a funding method.

If your user's linked account was added via Open Banking, then the user will be able to select one of two options highlighted in the screenshot below:

Payment Fund new options to fund

Once the user select either or option, the UI Component will trigger these events FUNDING_MANUAL or FUNDING_OPEN_BANKING

important

If the linked account was added manually, the Open Banking option is not available.

Back Button Function

A 'Back' button will be available on the Manual Funding screen if the linked account was added via Open Banking, allowing users to return and select a different funding option, including Open Banking.

info

If the linked account was added manually, the Back button will not be displayed on the Manual Funding screen.

For more details, refer to the full Payment Fund UI component documentation.

Affected UI Components


Mandatory Reference Field for Payment Run Fund UI

· One min read

To enable customers to fund a payment run via manual bank transfer, the Payment Fund UI component has been updated to include a mandatory reference field. Customers must provide this reference when submitting the payment run.

Effective:

  • Sandbox: 11 March 2025
  • Production: 11 March 2025

The reference field in the Payment Run Fund UI component is now mandatory. Customers must include this reference in their bank transfer instructions to ensure the correct allocation of funds and successful payment run funding.

Including a `reference eliminates any ambiguity about which payment run the transferred funds should be applied to.

The screenshot below displays the reference field:

Payment Fund UI Component - with reference

Important

To avoid funding issues, customers must input the correct reference in their bank transfer instructions. Failing to provide a reference or providing an incorrect reference will prevent the payment run from being executed, and the funds will be returned to the customer's linked account.

You can find more details in our documentation.


New Buttons & Events for Manual Bank Linking and Payment Funding

· 2 min read

We've added two new buttons to the Link Account and Payment Fund UI components for users manually linking a bank account or funding a payment run. Clicking these buttons now triggers two new events to confirm user interaction.

Effective:

  • Sandbox: 11 March 2025
  • Production: 11 March 2025

We've added a new 'Transfer Completed' button to the Link Account UI component for users manually linking an account instead of using Open Banking. Users can click this button (see image below) to notify you that the linked account control check step is complete.

Link Account - New Button

important

Clicking this button does not confirm that the user has completed the transfer.

When the user clicks the button, the UI component triggers a TRANSFER_COMPLETED event. For more details, refer to the Link Account UI component documentation.

Payment Fund UI Component

We've also added a new 'Funding Completed' button to the Payment fund UI component for users manually funding a payment run instead of using Open Banking. Users can click this button (see image below) to notify you that the Payment Run has been funded.

Payment Fund - New Button

important

Clicking this button does not confirm that the user has completed the funding request.

When the user clicks the button, the UI component triggers a FUNDING_COMPLETED event. For more details, refer to the Payment Fund UI component documentation.


New styling configuration in the UI Components

· One min read

We've introduced additional styling customisation options in the Link Account, Payment Fund and Payment Run Authorisation UI Components to enable you to better align with your brand's design.

Effective:

  • Sandbox: 27 February 2025
  • Production: 27 February 2025

This update allows you to customise the bank details container shown within the UI components as follows:

  • backgroundColor – Set a custom background color for the container.
  • separatorColor – Define the color of separators within the container.
  • Text Color Consistency – The text color will now automatically match the container’s text color for a more cohesive design.

For further details, refer to our documentation:


Breaking Change (March 2025) Open Banking Fallback - Manual Account Linking and Funding

· 6 min read

As mentioned in our previous update, we are introducing another way for your customers to link an account and fund their payment runs to cover instances when their bank is not supported via Open Banking. This initiative involves a number breaking change to the current AIS, PIS and Linked Account Declaration UI Components.

Effective:

  • 11 February 2025 on Sandbox
  • 04 March 2025 on Live

Users with the Controller role can now manually link their bank accounts, depending on the jurisdiction, without relying on Open Banking.

1. Updated UI component to include the manual option

To link an account manually, you can still load the current AIS UI Component, were the component has been updated to include a new URL, "Can't find your bank?" at the end of the UI Component as pictured below:

AIS UI Component

Breaking Change

To support manual account linking in addition to Open Banking, we have renamed the AIS UI Component weavrComponents.prompt.ais to weavrComponents.prompt.linkAccount. This change ensures our UI component reflects its broader functionality and aligns with evolving user needs.

2. Entering the bank account details

When the "Can't find your bank?" option is selected, the user will be directed to a new screen where they must enter their bank account details. The following key fields will be required:

  • Business Account Name: The registered owner’s name of the account at the external bank or PSP. This should match the name on the external account to ensure successful linkage and compliance with verification steps.
  • Bank Name: The name of the bank.
  • Bank Country: The country in which the bank or financial institution holding the account is located. This is essential for regulatory and compliance purposes.
  • Account Information: The IBAN or the combination of the Account Number and Sort Code of the account at the external bank or PSP. This uniquely identifies the account within the financial institution and is necessary for processing transactions.
webhook information

Once the bank account details are submitted, a Linked Account Update Webhook event will be triggered. This event will include the new id of the Linked Account and its status will transition to PENDING_CHALLENGE.

3. Declaration of Ownership via SCA Challenge

Ensuring that the registered linked account belongs to the Identity attempting to link it is crucial. As part of this process, declaration of ownership is conducted through a Strong Customer Authentication (SCA) challenge, which must be completed by a user with the Controller role.

Upon initiating the Linked Account registration, the Controller user must successfully complete the SCA challenge to confirm ownership.

webhook information

After successful completion, a Linked Account Update Webhook event will be triggered updating the linked account status to PENDING_FUNDING.

4. Control Check through a test funding Transaction

After successfully completing the SCA process, user must demonstrate control over the external account by performing a test funding transaction. The UI component will redirect the user to the final screen, displaying the following details:

  • Amount to be sent
  • Account number
  • Sort Code
  • Reference Code
danger

This step is critical to verify that the registered identity controls the account. It is essential that users include the reference code in the funding transaction. Failure to complete the test funding transaction will result in the linked account remaining in the PENDING_FUNDING state.

The funding transaction will not be needed for a Linked Account linked via Open Banking.

simulator to test on Sandbox

To assist you with testing the funding test transaction, we have created a new simulator accessible via our API here.

Webhook information

Once the plugin receives and validates the test funding transaction a Linked Account Update Webhook event will be triggered, updating the linked account status to LINKED.

Open Banking Fallback - Fund a Payment Run

Your users with the Controller role will be able to use the newly created manual linked account to fund the payment run.

1. Updated UI component to allow funding using a manual linked account

To use the manually linked account, the user can load the current PIS UI Component, were the component will have a new screen

Breaking Change

To support funding of a payment run with a linked account in addition to Open Banking, we have renamed the PIS UI Component weavrComponents.prompt.pis to weavrComponents.prompt.paymentFund. This change ensures our UI component reflects its broader functionality and aligns with evolving user needs.

Linked Account Declaration UI Component

When adding a Linked Account via Open Banking a user with the Controller role. of the Identity must complete an Strong Customer Authentication (SCA) challenge to confirm ownership of the Linked Account.

Currently, the SCA declaration process is handled using the Linked Account Declaration UI component.

State of the Linked account

The state of the linked account will to be SCA challenge will remain at PENDING_CHALLENGE.

What's Changing?

The SCA ownership declaration will now be managed through the new Linked Account UI component, formerly known as the AIS UI component.

This change offers a more streamlined and efficient solution for linking accounts.

When loading the new Linked Account UI component, you must provide the following parameters:

  • callbackUrl
  • state
  • linkedAccountId
danger

Previously, only linkedAccountId was required. Please ensure your integration reflects these changes:

webhook information

Linked Account updates will remain intact, and you will continue to receive the Linked Account Update webhook event with updates to linked accounts.

Breaking Change Updates

To make the UI component more generic and to support the Open Banking fallback of the manual account linking and funding initiative, we have renamed the below UI Components:

You will also need to start handling the new PENDING_FUNDING state. This state will be sent to you via an event in the UI component and in the Linked Account Update webhook event.

Also, the SCA ownership declaration will now be managed through the new Linked Account UI component, formerly known as the AIS UI component.

When loading the new Linked Account UI component, you must provide the following parameters:

  • callbackUrl
  • state
  • linkedAccountId

Action Required

Rename the UI Components as follows:

If no action is taken

Although this is a small change, if no action is taken, you application will not be able to load the AIS and PIS UI Components accordingly, resulting in your customers not being able to link an account or fund a payment run.

Also, your application will no longer support SCA declarations for Linked Accounts through Open Banking, potentially disrupting account link functionality.

Detailed instructions are available in our documentation on how to:


Breaking Change (March 2025) Deprecation of Linked Account Declaration UI Component

· 2 min read

We are deprecating the Linked Account Declaration UI component to streamline the loading process and simplify your integration with UI components.

Effective:

  • 11 February 2025 on Sandbox
  • 04 March 2025 on Live

Linked Account Declaration UI Component

When adding a Linked Account via Open Banking a user with the Controller role of the Identity must complete an Strong Customer Authentication (SCA) challenge to confirm ownership of the Linked Account.

Currently, the SCA declaration process is handled using the Linked Account Declaration UI component.

state of the linked account

The state of the linked account will to be SCA challenge will remain at PENDING_CHALLENGE.

What's Changing

The SCA ownership declaration will now be managed through the new Linked Account UI component, formerly known as the AIS UI component. More information on this can be found here.

This change offers a more streamlined and efficient solution for linking accounts.

When loading the new Linked Account UI component, you must provide the following parameters:

  • callbackUrl
  • state
  • linkedAccountId
danger

Previously, only linkedAccountId was required. Please ensure your integration reflects these changes.

Webhook Information

Linked Account updates will remain intact, and you will continue to receive the Linked Account Updatewebhook event with updates to linked accounts.

Action Required

Start using the weavrComponents.prompt.linkAccount instead of weavrComponents.prompt.linkedAccountDeclaration to perform SCA declarations for Linked Accounts. To load weavrComponents.prompt.linkAccount you must provide the following parameters:

  • callbackUrl
  • state
  • linkedAccountId

If no action is taken

If this change is not implemented, your application will no longer support SCA declarations for Linked Accounts through Open Banking, potentially disrupting account link functionality.

more information

More information and documentation will be shared with you closer to the breaking change date.


Breaking Change (March 2025) Open Banking Fallback - Manual Account Linking and Funding

· 5 min read

We are introducing another way for your customers to link an account and fund their payment runs to cover instances when their bank is not supported via Open Banking. This initiative involves a breaking change to the current AIS and PIS UI Components.

Effective:

  • 11 February 2025 on Sandbox
  • 04 March 2025 on Live

Users with the Controller role can now manually link their bank accounts, depending on the jurisdiction, without relying on Open Banking.

1. Updated UI component to include the manual option

To link an account manually, you can still load the current AIS UI Component, were the component has been updated to include a new URL, "Can't find your bank?" at the end of the UI Component as pictured below:

AIS UI Component

Breaking Change

To support manual account linking in addition to Open Banking, we have renamed the AIS UI Component weavrComponents.prompt.ais to weavrComponents.prompt.linkAccount. This change ensures our UI component reflects its broader functionality and aligns with evolving user needs.

2. Entering the bank account details

When the "Can't find your bank?" option is selected, the user will be directed to a new screen where they must enter their bank account details. The following key fields will be required:

  • Business Account Name: The registered owner’s name of the account at the external bank or PSP. This should match the name on the external account to ensure successful linkage and compliance with verification steps.
  • Bank Name
  • Bank Country: The country in which the bank or financial institution holding the account is located. This is essential for regulatory and compliance purposes.
  • Account Information: The IBAN or the combination of the Account Number and Sort Code of the account at the external bank or PSP. This uniquely identifies the account within the financial institution and is necessary for processing transactions.
webhook information

Once the bank account details are submitted, a Linked Account Update Webhook event will be triggered. This event will include the new id of the Linked Account and its status will transition to PENDING_CHALLENGE.

3. Declaration of Ownership via SCA Challenge

Ensuring that the registered linked account belongs to the Identity attempting to link it is crucial. As part of this process, declaration of ownership is conducted through a Strong Customer Authentication (SCA) challenge, which must be completed by a user with the Controller role.

Upon initiating the Linked Account registration, the Controller user must successfully complete the SCA challenge to confirm ownership.

webhook information

After successful completion, a Linked Account Update Webhook event will be triggered updating the linked account status to PENDING_FUNDING.

4. Control Check through a test funding Transaction

After successfully completing the SCA process, user must demonstrate control over the external account by performing a test funding transaction. The UI component will redirect the user to the final screen, displaying the following details:

  • Amount to be sent
  • Account number
  • Sort Code
  • Reference Code
caution

This step is critical to verify that the registered identity controls the account. It is essential that users include the reference code in the funding transaction. Failure to complete the test funding transaction will result in the linked account remaining in the PENDING_FUNDING state.

The funding transaction will not be needed for a Linked Account linked via Open Banking.

Webhook information

Once the plugin receives and validates the test funding transaction a Linked Account Update Webhook event will be triggered, updating the linked account status to LINKED.

Open Banking Fallback - Fund a Payment Run

Your users with the Controller role will be able to use the newly created manual linked account to fund the payment run.

1. Updated UI component to allow funding using a manual linked account

To use the manually linked account, the user can load the current PIS UI Component, were the component will have a new screen

Breaking Change

To support funding of a payment run with a linked account in addition to Open Banking, we have renamed the PIS UI Component weavrComponents.prompt.pis to weavrComponents.prompt.paymentFund. This change ensures our UI component reflects its broader functionality and aligns with evolving user needs.

Breaking Change Updates

To make the UI component more generic and to support the Open Banking fallback of the manual account linking and funding initiative, we have renamed the below UI Components:

You will also need to start handling the new PENDING_FUNDING state. This state will be sent to you via an event in the UI component and in the Linked Account Update webhook event.

Action Required

Rename the UI Components as follows:

If no action is taken

Although this is a small change, if no action is taken, you application will not be able to load the AIS and PIS UI Components accordingly, resulting in your customers not being able to link an account or fund a payment run.

more information

More information and documentation will be shared with you closer to the breaking change date.