Delete Bank Account

Use the Delete Bank Account API endpoint to delete a bank account and remove its association with a customer. #

📘

Important

Certain Credit API endpoints are in a draft status and are subject to change without notice. Thredd may modify interfaces, behaviour, and documentation as development continues.

The Delete Bank Account endpoint enables you to permanently remove a bank account from a customer's profile in the loan management system. This action cannot be undone.

❗️

Warning

Deleting a bank account is a permanent action. Once deleted, the bank account cannot be recovered. Ensure the bank account is no longer required before proceeding.

📘

More Information

For more information about the Bank Account endpoints, see: Bank Accounts.

Prerequisites

To integrate calls to the Delete Bank Account endpoint, you need:

  • The bank_account_id of the bank account to delete. This is returned when the bank account is created or can be retrieved using the List Bank Accounts by Customer endpoint.

Example Request

Delete a bank account by making a DELETE request to the Delete Bank Account endpoint.

DELETE {{baseUrl}}/api/v1/credit/bank-account/{bank_account_id}

Path Parameters

ParameterDescription
bank_account_idstring. Required. The unique identifier of the bank account.

Example Response

A successful request returns a 200 HTTP status code confirming the bank account has been deleted.

📘

Note

If the request contains invalid data or is incomplete, the system returns a 422 HTTP error and details of the validation failure.

{
  "isSuccess": true
}
{
  "detail": "Bank Account mapping not found."
}
{
  "detail": [
    {
      "loc": ["path", "bank_account_id"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Response Fields

AttributeDescription
isSuccessboolean. Indicates whether the operation was successful.

Error Messages

If there is a problem with the request, the response returns one of the following errors:

  • 404 — The bank account ID provided does not match an existing bank account.
  • 422 — A required field or its value is missing or invalid. The response includes details of the validation failure.

Did this page help you?