Archive an account
Archives a subledger account. Only subledger-type accounts (those created
via POST /v1/accounts) may be archived, and the account must have a
zero balance.
While archived, mutating operations on the account are blocked: transfers
into or out of the account, new deposit-address generation, fiat
withdrawals, payment-intent creation, and fetching wire instructions are
all rejected. Read endpoints (e.g. GET /v1/accounts/{accountId},
GET /v1/accounts/deposits) continue to work.
An archived account is excluded from the default GET /v1/accounts
listing; pass status=archived (or include archived in a multi-value
status filter) to retrieve it.
Archiving is idempotent: archiving an already-archived account succeeds.
An incoming deposit to a pre-existing deposit address or wire instruction
on the archived account will auto-unarchive it (status returns to
active).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the account.
"1000565227"
Body
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"
Response
Successfully archived the account.
An account exposed by the Accounts API.