Documentation

Delete Bank Account

Delete the existing bank account

Suggest Edits

To delete a bank account, this API requires two path parameters:

  • aggregator_type: Specifies the source type of the account’s aggregator.
  • account_uuid: The unique identifier associated with the subscribed bank account.

These parameters ensure the correct account is identified and processed.

📘

Authentication Route

This route is secured with processor and vendor token authentication.

Endpoint

   /3p/api/v2/bank-accounts/{aggregator_type}/{account_uuid}

 

Path Parameter

FieldsTypeIs RequiredDescription
aggregator_typestringYesPossible values:
bank_link
manual
plaid
account_uuidstringThe bank account uuid

Response Object

{
    "status": true,
    "message": "The bank account has been deleted.",
    "data": [],
    "errors": []
}

Errors & Warnings

{
    "status": false,
    "message": "Invalid value provided for Accept header.",
    "data": null,
    "errors": null,
    "error_code": {
        "type": "client_error",
        "subtype": "missing_accept_header"
    }
}

{
    "status": false,
    "message": "Invalid token.",
    "data": null,
    "errors": null,
    "error_code": {
        "type": "client_error",
        "subtype": "unauthorized"
    }
}

-----------------------------------------------------

{
    "status": false,
    "message": "Invalid token format. The token should be in the following format: ID|TOKEN_VALUE. Example: 12345|abcdefg",
    "data": null,
    "errors": null,
    "error_code": {
        "type": "client_error",
        "subtype": "invalid_token_format"
    }
}

-----------------------------------------------------

{
    "status": false,
    "message": "Invalid token format. The ID in the token must be an integer. Example: 12345|abcdefg",
    "data": null,
    "errors": null,
    "error_code": {
        "type": "client_error",
        "subtype": "invalid_token_format"
    }
}

{
    "status": false,
    "message": "Deletion is not possible while transactions are in progress.",
    "data": null,
    "errors": null,
    "error_code": null
}

{
    "status": false,
    "message": "No bank account found with given details.",
    "data": null,
    "errors": null,
    "error_code": {
        "type": "client_error",
        "subtype": "uuid_not_found"
    }
}

-----------------------------------------------------

{
    "status": false,
    "message": "The route 3p/api/v2/bank-accounts/bank_link could not be found.",
    "data": null,
    "errors": null,
    "error_code": null
}

Updated 3 days ago