Accounts and money

Freeze an account

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. Tenant freezes cannot be lifted over a system-plane freeze.

post/v1/accounts/{accountId}/freeze

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/accounts/{accountId}/freeze
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

accountIdstring required

Hyperscale account ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Request body

reasonstring required
reasonClass'customer_request' required

Response

Success

tenantIdstring required

Organization tenant ID

accountIdstring required

Hyperscale account ID

productIdstring

Hyperscale product ID

updatedAtstring date-time required
reasonstring required
reasonClass'customer_request' required
previousStatus'open' required
status'frozen' required

Changes

No recorded changes to this operation across all 1 revision of this API.