Skip to main content

New unlink a bank account endpoint

· 2 min read

Effective:

  • 14 May 2024 on Sandbox
  • 17 May 2024 on Live

We have created a new endpoint to enable users with controller role to unlink bank accounts. Bank accounts should be unlinked if the buyerBuyer A business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. does not want to use them to fund payment runsPayment Run A list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution. anymore, thus removing the risk of using the wrong bank account in the future.

New POST unlink endpoint​

The new endpoint POST/linked_accounts/\{linked_account_id}/unlink will have the following parameters:

  • Request: the linked_account_id to unlink
  • Response: the updated linkedAccount object and the status will change from CONNECTED and DISCONNECTED to LINKED and UNLINKED.

If your buyersBuyer A business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. try to confirm and/or fund a payment run using an unlinked account, you will receive an HTTP 409 error code LINKED_ACCOUNT_INVALID_STATE.

Linked AccountLinked Account An entity in the Weavr system that represents an external bank account or payment service provider (PSP) account which an Identity has verified they own and control. This feature enables users to perform transactions, such as outgoing and incoming wire transfers, between their Linked Accounts and their Managed Accounts as 'self-to-self' transfers. GET endpoint​

When calling the GET linked accounts or GET linked account endpoints, you will receive the unlinked account information with the status as UNLINKED and the consent of the account as EXPIRED.

Linked AccountLinked Account An entity in the Weavr system that represents an external bank account or payment service provider (PSP) account which an Identity has verified they own and control. This feature enables users to perform transactions, such as outgoing and incoming wire transfers, between their Linked Accounts and their Managed Accounts as 'self-to-self' transfers. webhook event​

You will be notified when a buyerBuyer A business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. unlinks an account if you are subscribed to the linked account webhook event. The linked accountLinked Account An entity in the Weavr system that represents an external bank account or payment service provider (PSP) account which an Identity has verified they own and control. This feature enables users to perform transactions, such as outgoing and incoming wire transfers, between their Linked Accounts and their Managed Accounts as 'self-to-self' transfers. webhook event will also be updated to receive the status as UNLINKED and the consent of the account as EXPIRED.

Affected Events

Affected API endpoints: