Offboarding
Less than to read
This guide demonstrates how a product should handle offboarding a users account from Banking Service.
API flow diagram
Step 1. Obtain an access token
Before integrating with the Banking Service UI, integrate with the Authentication Service.
To work with Banking Service, you need an access token (JWT) from Authentication Service. The JWT is generated using the unique IDs of the organisation (organisationId) and company (companyId). This JWT can be provided as a bearer token for Banking Service requests through the authorisation header: ‘Bearer ‘.
Step 2. Disconnect a bank account
When a user chooses disconnects their in-product bank account to a connected bank feed, call the DELETE bank accounts endpoint specifying the associated users bank account ID.
DELETE /{companyId}/bankaccounts/{bankAccountId}
| Headers | Description |
|---|---|
x-application |
This is your application identifier which is generated from the Authentication Service. |
Authorization |
This is the bearer token returned from your request to the /accesstoken endpoint as described in step 1. |
Content-Type |
This should be set as application/json. |
Step 3. Clear disconnected account data
Banking Sevice will complete following:
- Rules will be placed in a disconnected state.
- The specified bank account will be placed in a cancelled state and can never be reactivated.
- The bank or 3rd party will be informed of the disconnection, so they can peform any clean up action on their side.
- Transaction data will be hard deleted in the Banking Service for this bank account ID.
You should complete the following:
When calling the delete bank account endpoint you must clear the local bankAccountId in your database and the associated lastTransactionId for this account.
Recap
In this walkthrough we have looked at how a consuming application would integrate offboarding into their solution.