Accounts and money

Retrieve an Account

Retrieve a single Account by its accountId. A Hyperscale Account: a first-party, ledger-backed balance held for a platform, Product, entity, customer, escrow, settlement, or suspense purpose. It is never an external bank account.

get/v1/accounts/{accountId}

Request

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

Path parameters

accountIdstring required

Query parameters

productIdstring

Hyperscale product ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'

Response

Success

accountIdstring required

Hyperscale account ID

tenantIdstring required

Organization tenant ID

idstring required
role'tenant_billing' | 'tenant_credit' | 'tenant_settlement' | 'tenant_master_mirror' | 'customer_balance' | 'customer_investment' | 'instrument_account' | 'product_escrow' | 'product_pool' | 'product_credit' | 'product_revenue' | 'platform_estate_mirror' | 'platform_revenue' | 'platform_suspense'
currencystring
status'pending' | 'open' | 'frozen' | 'closed'
ownerParticipantIdstring
bookstring
externalboolean
contraboolean
createdOperationIdstring
ownerKind'platform' | 'tenant' | 'customer' | 'product' | 'external'
ownerCustomerIdstring

Tenant-local customer ID

productNamestring
accountLabelstring
ownerNamestring
holderLabelstring
updatedAtstring date-time required
createdAtstring date-time

Changes

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