Skip to main content
GET
Get settlement preference
Returns the UPA’s current preferred settlement profile, or null when no eligible destination has been selected. Change it with Set an account’s settlement preference.

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"

Response

Current settlement profile

settlementProfile
object | null
required