Hyperscale docs Sign in Start building

Create an account

account.create

Provisions a public ledger-backed account for the company, a customer, or a Product owner with a fixed currency and role. Escrow that an instrument owns is not a public account role; Hyperscale opens those accounts for the instrument.

POST /v1/accounts

Scopes: account:write

Input

FieldTypeDescription
owner requiredobject
productIdstringHyperscale product ID
role requiredtenant_billing | tenant_credit | tenant_settlement | customer_balance | customer_investment | product_pool | product_credit | product_revenue
currency requiredstring
metadataobject
idempotencyKey requiredstringNew per change; reuse only to retry it.

Request sample

curl --request POST 'https://console.hyperscale0.ai/v1/accounts' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "owner": "<object>",
  "role": "<tenant_billing | tenant_credit | tenant_settlement | customer_balance | customer_investment | product_pool | product_credit | product_revenue>",
  "currency": "<string>",
  "idempotencyKey": "<string>"
}'

All operations