Skip to main content

Delete Account


Overview​

You can delete an account in INACTIVE status by using the DELETE method, as described below.


Resource Access​

Production (api.ahrvo.network)

DELETE https://api.ahrvo.network/banking/us2/v1/customer/id/{customerId}/account/id/{accountId}

Staging (gateway.ahrvo.network)

DELETE https://gateway.ahrvo.network/banking/us2/v1/customer/id/{customerId}/account/id/{accountId}

Authentication​

HeaderDescription
AuthorizationBearer {JWT token}
x-api-keyYour API key
Content-Typeapplication/json

Path Parameters​

ParameterTypeDescription
customerIdintegerInternal customer ID
accountIdintegerInternal account ID

Example Request​

DELETE /banking/us2/v1/customer/id/4052981/account/id/4024062 HTTP/1.1
Host: api.ahrvo.network
Authorization: Bearer {placeholder("JWT token")}
x-api-key: {placeholder("your-api-key")}
Content-Type: application/json

Example Response​

HTTP Status: 200 OK

Important Notes​

INACTIVE Status Required

An account can only be deleted if it is in INACTIVE status. Attempting to delete an account in any other status will result in a 400 Bad Request error.

Irreversible Action

Deleting an account is an irreversible operation. Ensure you have confirmed the deletion before making the request.

Close vs Delete

To remove an ACTIVE account, use the Close Account endpoint instead. Closing an account handles outstanding balances and transitions the account to a closed state.


Interactive API Explorer​