Remove external account

The POST /netevia/externalAccount/close/{profileId} API is designed to enable users to remove an external bank account that is linked to their profile within a banking application. By sending a request to this endpoint with the specified profile ID, users can effectively terminate the connection to the external account. It is crucial for users to ensure that all necessary prerequisites for closing the account are fulfilled before invoking this method to avoid potential errors or incomplete closures.

Functionality

  • Profile Identification: The API identifies the specific user profile associated with the provided profile ID to determine which external bank account is being removed.
  • Prerequisite Validation: The API checks if all conditions required for closing the account are met. This may include verifying that there are no pending transactions, that the account balance is zero, and that any other closure criteria are satisfied.
  • Account Closure Processing: If the validation checks pass, the API proceeds to removed the external bank account, removing it from the user's profile and terminating any associated services.
  • Confirmation Notification: A confirmation message is prepared to inform the user that the account has been successfully removed.
📘

Summary:

The POST /netevia/externalAccount/close/{profileId} API is an essential tool for users wishing to terminate a connection to an external bank account linked to their profile. By providing a straightforward process for closing accounts, this API enhances account management capabilities while ensuring that all necessary closure prerequisites are satisfied. With robust validation and clear feedback, users can confidently manage their external banking relationships, ensuring a smooth and efficient account closure experience.

Path Params
int32
required
Query Params
string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json