Unenroll from cash sweep

curl --request DELETE \
  --url https://api.bluumfinance.com/v1/investors/{investor_id}/cash-sweep/enroll \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "disclosure_acceptance": {
    "signed_at": "2023-11-07T05:31:56Z",
    "ip_address": "<string>",
    "user_agent": "<string>",
    "actor_ref": "<string>"
  }
}
'

{
  "id": "<string>",
  "object": "cash_sweep_enrollment",
  "created": 123,
  "livemode": true,
  "metadata": {},
  "investor_id": "<string>",
  "brokerage_account_id": "<string>",
  "apr_tier_name": "<string>",
  "apr_tier_id": "<string>",
  "account_rate_bps": 123,
  "enrolled_at": "2023-11-07T05:31:56Z",
  "unenrolled_at": "2023-11-07T05:31:56Z",
  "accepted_disclosures": [
    "<string>"
  ],
  "cutoff_acknowledgement": {
    "cutoff": "11:45 AM ET",
    "message": "<string>"
  }
}

Cash Sweep

Unenroll from cash sweep

Voluntary opt-out from the High Yield Cash program. Users request the opt-out through the partner; the partner relays it to the custodian by calling this endpoint. This is a regulatory requirement — the user must be able to leave the program on demand.

Cutoff acknowledgement. Requests received before 11:45 AM ET are processed the same business day; requests received at or after 11:45 AM ET are processed the next business day. The response includes a cutoff_acknowledgement object the partner can render directly so the user sees deterministic copy about when their opt-out will take effect — partners should not re-derive the rule.

The investor’s metadata.config.highYieldCashEnrolled flag flips to false automatically once the custodian confirms the unenrollment (status transitions to inactive).

Exit acknowledgement (required). The user must accept the hyc_exit_acknowledgement disclosure (confirming they are leaving the program and understand the 11:45 AM ET cutoff). Supply it inline via disclosure_acceptance, or pre-record it via POST /v1/investors/{investor_id}/disclosures/acceptances. If neither is present the request is rejected with 400 and the disclosure text.

DELETE

investors

{investor_id}

cash-sweep

enroll

Unenroll from cash sweep

curl --request DELETE \
  --url https://api.bluumfinance.com/v1/investors/{investor_id}/cash-sweep/enroll \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "disclosure_acceptance": {
    "signed_at": "2023-11-07T05:31:56Z",
    "ip_address": "<string>",
    "user_agent": "<string>",
    "actor_ref": "<string>"
  }
}
'

{
  "id": "<string>",
  "object": "cash_sweep_enrollment",
  "created": 123,
  "livemode": true,
  "metadata": {},
  "investor_id": "<string>",
  "brokerage_account_id": "<string>",
  "apr_tier_name": "<string>",
  "apr_tier_id": "<string>",
  "account_rate_bps": 123,
  "enrolled_at": "2023-11-07T05:31:56Z",
  "unenrolled_at": "2023-11-07T05:31:56Z",
  "accepted_disclosures": [
    "<string>"
  ],
  "cutoff_acknowledgement": {
    "cutoff": "11:45 AM ET",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Path Parameters

investor_id

string

required

Investor ID (prefixed, e.g. inv_...)

Body

application/json

Optional inline acceptance of the HYC exit acknowledgement (hyc_exit_acknowledgement). Required to unenroll unless the acknowledgement was pre-recorded via the disclosure-acceptance endpoint.

disclosure_acceptance

object

Show child attributes

Response

Unenrollment initiated

string

Prefixed enrollment ID (e.g. cse_...)

object

enum<string>

Available options:

cash_sweep_enrollment

created

integer

Unix timestamp of creation

livemode

boolean

metadata

object

investor_id

string

brokerage_account_id

string

variant

enum<string>

Available options:

non_shariah,

shariah

status

enum<string>

Available options:

pending_enrollment,

active,

pending_unenrollment,

inactive

apr_tier_name

string | null

apr_tier_id

string | null

account_rate_bps

integer | null

enrolled_at

string<date-time> | null

unenrolled_at

string<date-time> | null

accepted_disclosures

string[]

Ids of every HYC disclosure that was acknowledged on the way to this enrollment (pre-recorded + newly recorded inline on this request). Returned on the enroll response so the partner UI can show the full list without a follow-up GET on the disclosure-acceptances endpoint.

cutoff_acknowledgement

object

Acknowledgement of the High Yield Cash 11:45 AM ET processing cutoff. Returned on unenroll (and surfaced where else relevant) so partner UIs can render deterministic copy about when the request will take effect, without re-implementing the timezone math.

Show child attributes

Enroll in cash sweep Get cash sweep enrollment