Skip to content
Developer home

Disconnection

  Less than to read

This walkthrough covers the API flow for offboarding. This is caused when a customer disconnects from in their product. In this guide we will walk through the API calls made to and from the Banking Service from your application and consuming product to demonstrate the offboarding flow detailed within our postman collection.

Read our API flow overview before following this walkthrough. This covers any prerequisites and how to use our Postman collections.


API flow diagram

Flow diagram displaying the authorisation flow


1. User disconnects

When the user chooses to disconnect their account, the consuming product will send a DELETE request to the Banking Service specifying the ID of the account to be deleted. This initiates the deletion of their account.

POST /notification

Connector API

Once removed the Banking Service will set the status of this account to cancelled and notify the provider by calling the /notification endpoint with the following payload. The provider can then perform any action required for clean up.

{
  "type": "resourceDeleted",
  "resource": {
    "id": "36aed119-675f-4507-9da3-06a5914d95ee",
    "type": "bankAccount",
    "url": "NA"
  },
  "additionalData": {
    "externalId": "13b437a2-e0bb-4d06-8dc1-618ea2b6a723:0b035aef-9e1e-406e-9815-06409757f05e",
    "bankId": "10aaeee6-4691-4443-8198-df39aaa8007c"
  }
}

Description of the fields:

  • resource.id: The identifier of the bankAccount resource being deleted.
  • additionalData.externalId: The externalId that was provided to Banking Service by the provider in the PATCH /authorisations call.

Recap

In this walkthrough we have gone through the Banking Service flow for when a customer disconnects their account. We have shown how the consuming product initiates this process with the Banking Service and how the provider is notified after the account has been cancelled.