Sign in
latestOpenAPI 3.1.02026-08-163864115.7 MB

c363cb2feb95

Ledgers

List Financial Activity

Returns an account's or user's activity feed: every movement of money in or out.

get/financial-activity

Query parameters

account_idstring

The owning account ID (a biz_ identifier). Provide this or user_id.

user_idstring

The owning user ID (a user_ identifier). Provide this or account_id.

include_owned_accountsboolean

When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning account.

include_resourceboolean

Whether to include the resource field in the response or not. Consider passing false if you need a fast response without as many rich details.

line_typesstring[]

Optional ledger line categories to include. Some categories (for example onchain_deposit, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here.

[
  "onchain_deposit"
]
currencystring

Optional currency code filter, for example usd.

posted_afterstring date-time

Only include rows posted after this ISO 8601 timestamp.

posted_beforestring date-time

Only include rows posted before this ISO 8601 timestamp.

available_afterstring date

Only include rows whose funds became withdrawable on or after this YYYY-MM-DD settlement date (UTC), distinct from posted_at. Requires currency.

available_beforestring date

Only include rows whose funds became withdrawable on or before this YYYY-MM-DD settlement date (UTC). Set equal to available_after for a single day. Requires currency.

limitinteger

Maximum number of rows to return.

cursorstring

Cursor returned by the previous page.

Response

activities listed for a user

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/shine-time-logo",
        "object": "account",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Shine Time Auto Detailing"
      },
      "amount": "2375000000",
      "available_at": "2026-01-01T12:00:00.000Z",
      "created_at": "2026-01-01T12:00:00.000Z",
      "currency": {
        "code": "usd",
        "precision": "100000000"
      },
      "id": "line_3",
      "ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
      "line_type": "payment_gross",
      "object": "ledger_activity",
      "posted_at": "2026-01-01T12:00:00.000Z",
      "resource": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/shine-time-logo",
        "object": "account",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Shine Time Auto Detailing"
      },
      "source": {
        "amount_float": 1500,
        "chain": "plasma",
        "claim_url": "https://whop.com/claim",
        "created_at": "2026-01-01T12:00:00.000Z",
        "estimated_arrival": "2026-01-01T12:00:00.000Z",
        "from_amount": "502.51",
        "from_currency": "usdt",
        "id": "airdrp_xxxxxxxxxxxxxx",
        "object": "airdrop_link",
        "payer_name": "MassPay",
        "payout_destination": {
          "icon_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/ach-activity-icon",
          "payer_name": "ACH Bank Deposit"
        },
        "payout_token_nickname": "Ops checking",
        "reason": "bounty_payout",
        "sender_address": "0x8a4de51b9c37f2e6a0d1b8c94e5f7a2d3c6b0e19",
        "status": "fully_claimed",
        "to_amount": "500.0",
        "to_currency": "usd",
        "tx_hash": "0x5d84a1c7e2f9b036d48c5a7e1b9f2d6c3a8e0b4f7c1d9e5a2b6f8c0d3e7a1b52"
      }
    }
  ],
  "page_info": {
    "end_cursor": "cursor_2",
    "has_next_page": true,
    "start_cursor": "cursor_1"
  }
}