Skip to main content
GET
/
investors
/
{investor_id}
/
withdrawals
List withdrawals for an account
curl --request GET \
  --url https://api.bluumfinance.com/v1/investors/{investor_id}/withdrawals \
  --header 'Authorization: Basic <encoded-value>'
{
  "object": "list",
  "url": "/v1/investors/inv_…/deposits",
  "has_more": false,
  "data": [
    {
      "object": "investor",
      "livemode": false,
      "id": "inv_01j9x8m2k7qpzwv3t5r6y8n0ab",
      "created": 1747776000,
      "metadata": {},
      "investor_id": "<string>",
      "wallet_id": "<string>",
      "funding_source_id": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "method_details": {
        "provider_name": "<string>",
        "transfer_id": "<string>",
        "alpaca_status": "<string>"
      },
      "destination_details": {},
      "initiated_at": "2023-11-07T05:31:56Z",
      "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

The prefixed public id of the investor (e.g. inv_…).

Query Parameters

​
method
enum<string>

Filter withdrawals by method.

Available options:
ach,
wire,
international_wire,
manual_bank_transfer
​
status
enum<string>

Filter withdrawals by status. Accepts the internal lifecycle values (note canceled, single "l"); the status field on responses uses the collapsed external vocabulary (pending, processing, completed, cancelled, failed).

Available options:
pending,
processing,
submitted,
completed,
canceled,
failed
​
currency
string

Filter withdrawals by currency (3-letter ISO code).

Required string length: 3
​
date_from
string

Filter withdrawals from this date (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
​
date_to
string

Filter withdrawals to this date (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
​
limit
integer
default:50

Maximum number of withdrawals to return.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of withdrawals to skip for pagination.

Required range: x >= 0

Response

List of withdrawals for the account

List envelope of withdrawal resources.

​
object
enum<string>
required
Available options:
list
​
url
string
required

The endpoint path that produced this list.

Example:

"/v1/investors/inv_…/deposits"

​
has_more
boolean
required

Whether more results exist beyond data.

Example:

false

​
data
object[]
required