Skip to main content
PATCH
Update interest enrollment

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Headers

Idempotency-Key
string
required

Client-supplied key that deduplicates retried requests. Reusing a key returns the original result instead of repeating the action.

Api-Signature
string
required

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

Pattern: ^[0-9A-Fa-f]{128,160}$
Api-Timestamp
integer<int64>
required

Current timestamp, represented as unix epoch seconds

Path Parameters

accountId
string<uuid>
required

Unique identifier for the account

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Body

application/json
interestEnrolled
boolean
required

Desired enrollment state. Set to true to enroll the account in the fiat cash interest program, false to unenroll it.

Response

Success

interestEnrolled
boolean
required

Whether the account is enrolled in the fiat cash interest program.