Close an account

DELETE

/accounts/{id}

Closes an account belonging to the authenticated entity by setting its status to closed. This is a soft delete — the account record is preserved, not removed, and its status becomes terminal (a closed account cannot be reopened or modified further). The account must belong to the authenticated entity; the entity_id from the bearer token is automatically applied as a scoping condition, so callers cannot close accounts belonging to other entities. If the account has an associated ledger account, its live balance is checked first: closure is rejected if there is any non-zero available balance, pending credit, or pending debit, since funds must be cleared out before an account can be closed.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Account closed successfully.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/accounts/01HQZR2BKPFQ8MXJVT3G7LWNE' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Account closed successfully",
    "status": "success",
    "data": {
        "id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
        "status": "closed"
    }
}

Modified at 2026-09-30 00:29:30

List accounts

Update an account