Accounts and money

Create an account

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. A product's credit/revenue treasury pair is provisioned separately during product setup. The currency, role, and normal balance are set at creation and cannot be changed afterward.

post/v1/accounts

Request

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

Headers

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

Request body

ownerAccountOwner required(unresolved $ref)
productIdstring

Hyperscale product ID

role'tenant_billing' | 'tenant_credit' | 'tenant_settlement' | 'customer_balance' | 'customer_investment' | 'product_pool' | 'product_credit' | 'product_revenue' required
currency'SAR' required
metadataMetadata (unresolved $ref)

Response

Success

accountIdstring required

Hyperscale account ID

tenantIdstring required

Organization tenant ID

ownerAccountOwner required(unresolved $ref)
productIdstring

Hyperscale product ID

role'tenant_billing' | 'tenant_credit' | 'tenant_settlement' | 'customer_balance' | 'customer_investment' | 'product_pool' | 'product_credit' | 'product_revenue' required
currency'SAR' required
normalBalance'debit' | 'credit' required
status'open' required

Changes

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