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 buyer does not want to use them to fund payment runs 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 buyers 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 Account 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 Account webhook event​

You will be notified when a buyer unlinks an account if you are subscribed to the linked account webhook event. The linked account 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: