Update a subaccount's interest enrollment

Permissions required: Subaccount

Set the subaccount's enrollment in the fiat cash interest program.

The subaccount's enrollment state is updated before this call returns, and
the response reports it. Its fiat wallets are then aligned to that state in
the background, so they follow the 202 rather than coincide with it. If that
alignment proves impossible the stored state is rolled back, and a later read
reports the previous value: the state means interest is active on the
subaccount, not that a change to it was requested.

Only the fiat wallets the subaccount holds at the moment of the call are
aligned. A fiat wallet provisioned afterwards does not inherit the setting,
and re-sending this request does not correct it — a request matching the
subaccount's current state succeeds without touching any wallet. Aligning
wallets created later is not supported yet.

A subaccount created under an enrolled firm starts enrolled, and one created
under a firm that is not enrolled starts unenrolled; use this endpoint to
change that afterwards, in either direction. Enrolling is rejected with a 422
unless the firm itself has been granted access to the interest feature;
unenrolling is never gated.

A subaccount that is closed, or awaiting review, cannot be changed at all and
is rejected with a 409 whichever state is requested — including a request
that matches the state it already holds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique Identifier for the subaccount

Body Params

Desired fiat cash-interest enrollment state for the subaccount.

boolean
required

Desired enrollment state. false unenrolls the subaccount; true enrolls it.

Headers
string
required
^[0-9A-Fa-f]{128,160}$

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

int64
required

Current timestamp, represented as unix epoch seconds

string
required
length between 1 and 128

Client-provided key that deduplicates this enrollment change. Use a new
key for every change. Replaying the identical request under a key already
used is ignored, and the response reports the state the first request left
in place. Reusing the same key with a different body is rejected with a
422 and changes nothing.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json