STstellar
Distribution Wallets

Create Distribution Account

Changed on

Creates and provisions a new distribution account. The account is generated, funded, and given its own signing key, isolated from the tenant's other accounts.

Owner only. Available only to tenants using the DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT account type, up to a maximum of 20 accounts.

post/distribution-wallets

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Request body

namestring required

Human-readable name for the new account

descriptionstring

Optional description

Response

Distribution account created successfully

idstring

Unique identifier for the account

namestring

Human-readable name for the account

descriptionstring

Optional description

distribution_account_addressstring

The account's Stellar address. Absent until the account has been provisioned on the network.

distribution_account_type'DISTRIBUTION_ACCOUNT.STELLAR.ENV' | 'DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT' | 'DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT'

How the account's secret is stored. Additional accounts are always DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT.

distribution_account_status'ACTIVE' | 'PENDING_USER_ACTIVATION'

Status of the underlying Stellar account

status'ACTIVE' | 'PENDING' | 'ARCHIVED'

Lifecycle status. PENDING accounts have been reserved but not yet funded on the network and cannot send. ARCHIVED accounts accept no new disbursements and are never deleted.

is_defaultboolean

Whether this is the tenant's default account. Exactly one account is the default, and it cannot be archived.

created_atstring date-time
updated_atstring date-time
archived_atstring date-time

When the account was archived, if it has been

Changes