Skip to main content
GET
/
cash-management
/
programs
/
{program_id}
Get a cash management program
curl --request GET \
  --url https://api.bluumfinance.com/v1/cash-management/programs/{program_id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "cmp_01j9x8m2k7qpzwv3t5r6y8n0ab",
  "object": "cash_management_program",
  "created": 1750000000,
  "livemode": true,
  "name": "<string>",
  "status": "active",
  "variant": "conventional",
  "currencies": [
    "<string>"
  ],
  "enrollment_mode": "<string>",
  "liquidity_preference": "<string>",
  "minimum_balance": "<string>",
  "reinvestment_enabled": true,
  "auto_sweep_enabled": true,
  "auto_sweep_rules": {
    "minimum_idle_balance": "10.00",
    "reserve_amount": "100.00",
    "max_sweep_percentage": "100.00"
  },
  "required_disclosure_ids": [
    "<string>"
  ],
  "approved_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

program_id
string
required
Example:

"cmp_01j9x8m2k7qpzwv3t5r6y8n0ab"

Response

Program details

id
string
Example:

"cmp_01j9x8m2k7qpzwv3t5r6y8n0ab"

object
string
Example:

"cash_management_program"

created
integer
Example:

1750000000

livemode
boolean
name
string
status
enum<string>

Programs are Bluum-managed and born active.

Available options:
active,
paused,
suspended,
closed
Example:

"active"

variant
string
Example:

"conventional"

currencies
string[]
enrollment_mode
string
liquidity_preference
string
minimum_balance
string
reinvestment_enabled
boolean
auto_sweep_enabled
boolean
auto_sweep_rules
object
required_disclosure_ids
string[]
approved_at
string<date-time> | null