Freeze an account
account.freeze
Moves an open account to frozen status without mutating ledger balances, holds, or internal transfers. While frozen, transfer legs that debit the account always refuse; credits refuse per the freeze reason class.
POST /v1/accounts/{accountId}/freeze
Scopes: account:write
Input
| Field | Type | Description |
|---|---|---|
accountId required | string | Hyperscale account ID |
reason required | string | |
reasonClass required | customer_request | |
idempotencyKey required | string | New per change; reuse only to retry it. |
Request sample
curl --request POST 'https://console.hyperscale0.ai/v1/accounts/{accountId}/freeze' \
--header "Authorization: Bearer $HYPERSCALE_API_KEY" \
--header 'X-Hyperscale-Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
"reason": "<string>",
"reasonClass": "<customer_request>",
"idempotencyKey": "<string>"
}'