Skip to main content
PUT
Set account settlement preference
Pass a settlementDestinationId returned by List an account’s settlement destinations, and optionally an assetSymbol. The destination must be active: crypto destinations resolve to their linked wallet, and unverified bank and rail destinations fail closed. Repeating the same preference returns the existing profile. Deposits and Payments that already exist keep their immutable settlement snapshot. See Settlement destinations.

Authorizations

Authorization
string
header
required

HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.

Headers

Stableyard-Version
enum<string>

Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.

Available options:
2026-09-09

Path Parameters

accountId
string
required

Canonical account id returned by the Accounts API.

Example:

"acct_123"

Body

application/json

Select an active typed settlement destination returned by the settlement-destinations endpoint. Native assets cannot be selected for token settlement. THBT is Movement-only. JPYC is Polygon-only. USDG is Robinhood Chain-only (4663).

settlementDestinationId
string
required

Use the ID returned by GET /v2/accounts/{accountId}/settlement-destinations.

Example:

"destination_123"

assetSymbol
enum<string>
Available options:
USDC,
USDT,
THBT,
JPYC,
USDG
Example:

"USDC"

Response

Settlement profile

id
string
required
Example:

"settle_123"

accountId
string
required
Example:

"acct_123"

version
integer
required
Required range: x >= 1
Example:

2

connectedWalletId
string | null
required
Example:

"wallet_123"

settlementDestinationId
string | null
required
Example:

"destination_123"

status
enum<string>
required
Available options:
draft,
active,
inactive,
failed
destinationType
enum<string>
required
Available options:
smart_wallet,
connected_wallet,
external_wallet
chainId
enum<integer>
required

Supported settlement chain IDs: Arbitrum=42161, Ethereum=1, Base=8453, Polygon=137, BNB Smart Chain=56, Avalanche=43114, Robinhood Chain=4663, Tempo=4217, Solana=10103, Movement=10002. Settlement currently supports EVM, Solana, and Movement token destinations. Movement also supports THBT, while Polygon supports direct same-chain JPYC settlement. Tron is deposit-only for settlement-fee escrow.

Available options:
42161,
1,
8453,
137,
56,
43114,
4663,
4217,
10103,
10002
destinationAddress
string
required
Example:

"11111111111111111111111111111111"

assetSymbol
enum<string>
required
Available options:
USDC,
USDT,
THBT,
JPYC,
USDG
tokenAddress
string
required
Example:

"0xaf88d065e77c8cC2239327C5EDb3A432268e5831"

snapshot
object
required
createdAt
string<date-time>
updatedAt
string<date-time>