Skip to main content
POST
/
investors
/
{investor_id}
/
cash-management
/
sweeps
Create a sweep (pull external cash into the Bluum wallet)
curl --request POST \
  --url https://api.bluumfinance.com/v1/investors/{investor_id}/cash-management/sweeps \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "amount": "1500.00",
  "funding_source_id": "fs_01j9x8m2k7qpzwv3t5r6y8n0ab",
  "idempotency_key": "<string>",
  "description": "<string>"
}
'
{
  "id": "swp_01j9x8m2k7qpzwv3t5r6y8n0ab",
  "object": "cash_management_sweep",
  "created": 123,
  "livemode": true,
  "cash_management_account_id": "<string>",
  "currency": "<string>",
  "amount": "<string>",
  "sweep_type": "<string>",
  "funding_source_id": "<string>",
  "deposit_id": "<string>",
  "status": "processing",
  "completed_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<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
Example:

"inv_01j9x8m2k7qpzwv3t5r6y8n0ab"

Body

application/json
​
currency
string
required
Example:

"USD"

​
amount
string
required
Example:

"1500.00"

​
funding_source_id
string
required
Example:

"fs_01j9x8m2k7qpzwv3t5r6y8n0ab"

​
sweep_type
enum<string>
Available options:
manual,
auto
​
method
enum<string>
Available options:
ach,
manual_bank_transfer,
wire,
international_wire
​
idempotency_key
string
​
description
string

Response

201 - application/json

Sweep created

​
id
string
Example:

"swp_01j9x8m2k7qpzwv3t5r6y8n0ab"

​
object
string
Example:

"cash_management_sweep"

​
created
integer
​
livemode
boolean
​
cash_management_account_id
string
​
currency
string
​
amount
string
​
sweep_type
string
​
funding_source_id
string
​
deposit_id
string | null
​
status
string
Example:

"processing"

​
completed_at
string<date-time> | null
​
failure_reason
string | null