Skip to main content

Deleting Data

Scopes Required: banking-upload

Foreword​

Upon inspecting the features below, you may notice that account-related operations require the appropriate banking scope. For external customers, the banking-upload scope is mandatory to perform any account or transaction deletion.

For all manual upload operations—including account and transaction deletion—you must use the banking-upload scope. This ensures that only manually uploaded data can be modified or removed.

Transaction deletion is only possible for manually uploaded data. Deletion of transactions fetched from banks is not permitted due to regulatory requirements.

Delete a single Account​

Remove a single external account completely. All transactions and account metadata are deleted.

Endpoint: DELETE /users/{user-id}/banking/accounts/{account-id}

What's Possible​

  • Delete one account by its account-id.
  • Remove all transactions and metadata associated with the account.

Model​

  • account-id - The ID of the account to delete

Journey / Narrative​

Identify the account to delete. Send a DELETE request with the account ID in the path. The Banking module removes the account and all associated data permanently.

Delete Multiple Accounts​

Remove multiple accounts in a single request by specifying an array of IDs.

Endpoint: DELETE /users/{user-id}/banking/accounts

What's Possible​

  • Delete multiple accounts at once.
  • Each account specified by accountId in the request body.
  • All transactions and metadata associated with the accounts are removed.

Model​

  • IDs - Array of account IDs to delete

Please note that array must be embedded in an object, e.g., { "ids": [ "accountId1", "accountId2" ] }.

Journey / Narrative​

Identify all accounts to remove. Send a DELETE request with the array of IDs. The Banking module deletes all specified accounts and their associated data.

Delete Transactions​

Remove specific transactions from an account.

Endpoint: DELETE /users/{user-id}/banking/accounts/{account-id}/transactions

What's Possible​

  • Delete one or multiple transactions by transactionId
  • Preserve the account and remaining transactions
  • Clean up duplicates or incorrect entries without re-uploading the entire account

Model​

  • ids - Array of transaction IDs to delete

Journey / Narrative​

Identify transactions to remove. Send a DELETE request with the ids array. The Banking module removes the specified transactions. Remaining transactions remain untouched.

Best Practices for Deletion​

Double-check IDs: Deletion is irreversible. Always confirm the IDs before sending requests.

Use batch deletion cautiously: Multiple accounts can be deleted at once, but be aware all associated transactions are also removed.

Log deletions: Keep an audit trail of removed accounts and transactions for compliance.

Combine with partial updates: If only certain transactions need removal, use DELETE transactions instead of deleting the whole account.