Sign in
ledger-sub-accounts

Delete sub-account by sub-account ID.

This endpoint deletes sub-account by sub-account ID. The sub-account must have zero balance before it can be deleted. The endpoint will return an error if the sub-account has a non-zero balance. The funds in the sub-account must be transferred to another account before deletion. Once an account is deleted, it cannot be recovered, and a new sub-account must be created if needed. The address associated with the sub-account will also be deleted upon successful deletion of the sub-account.

delete/ledger/subaccounts/{subAccountIdRef}

Path parameters

subAccountIdRefstring required

The unique onboard sub-account ID or reference

Response

Sub-account deleted Successfully

successboolean required

Status can be successful or failed, a value of true indicates success.

messagestring

additional message describing status.

dataobject

Data associated with the status, this will not always be present

Example response

{
  "success": true,
  "error": {
    "code": "UNKNOWN_ERROR",
    "message": "Request could not be completed due to an error"
  }
}

Changes

Changed in 1 of the 6 revisions of this API.2

  • a3c4e27426152See the full diff
    • ○

      the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog