Skip to main content
Promote Account To Default

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Path Parameters

id
string
required

The unique identifier of the distribution account

Response

Distribution account promoted successfully

A distribution account the tenant sends funds from.

id
string

Unique identifier for the account

name
string

Human-readable name for the account

description
string

Optional description

distribution_account_address
string

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

distribution_account_type
enum<string>

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

Available options:
DISTRIBUTION_ACCOUNT.STELLAR.ENV,
DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT,
DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT
distribution_account_status
enum<string>

Status of the underlying Stellar account

Available options:
ACTIVE,
PENDING_USER_ACTIVATION
status
enum<string>

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.

Available options:
ACTIVE,
PENDING,
ARCHIVED
is_default
boolean

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

created_at
string<date-time>
updated_at
string<date-time>
archived_at
string<date-time>

When the account was archived, if it has been