STstellar
Distribution Wallets

Archive Distribution Account

Changed on

Archives a distribution account. Owner only.

Archived accounts accept no new disbursements but keep serving reads, so past records stay resolvable. Two accounts cannot be archived and return 400: the tenant's default, which requires promoting another account first, and the last remaining active account.

post/distribution-wallets/{id}/archive

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

Path parameters

idstring required

The unique identifier of the distribution account

Response

Distribution account archived 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